Changes since
the last release

com.ebay.sdk.call
Class ReviseMyMessagesCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.ReviseMyMessagesCall

public class ReviseMyMessagesCall
extends ApiCall

Wrapper class of the ReviseMyMessages call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: MessageIDs - This container is used to specify up to 10 messages (specified with their MessageID values) on which to perform on or more actions. At least one MessageID value must be included in the request. MessageID values can be retrieved with the GetMyMessages call with the DetailLevel value set to ReturnHeaders.

Note: Messages in the Sent folder of My Messages cannot be moved, marked as read, or flagged.
Input property: AlertIDs - This field is deprecated.
Input property: Read - This boolean field is used to change the 'Read' status of the message(s) in the MessageIDs container. Including this field and setting its value to true will mark all messages in the MessageIDs container as 'Read'. Conversely, including this field and setting its value to false will mark all messages in the MessageIDs container as 'Unread'. The 'Read' status of a message can be retrieved by looking at the Message.Read boolean field of the GetMyMessages call response.

In each ReviseMyMessages call, at least one of the following fields must be specified in the request: Read, Flagged, and FolderID.

Note: Messages in the Sent folder of My Messages cannot be moved, marked as read, or flagged.
Input property: Flagged - This boolean field is used to change the 'Flagged' status of the message(s) in the MessageIDs container. Including this field and setting its value to true will flag all messages in the MessageIDs container. Conversely, including this field and setting its value to false will unflag all messages in the MessageIDs container. The 'Flagged' status of a message can be retrieved by looking at the Message.Flagged boolean field of the GetMyMessages call response.

In each ReviseMyMessages call, at least one of the following fields must be specified in the request: Read, Flagged, and FolderID.

Note: Messages in the Sent folder of My Messages cannot be moved, marked as read, or flagged.
Input property: FolderID - A unique identifier of My Messages folder. A FolderID value is supplied if the user want to move the message(s) in the MessageIDs container to a different folder. FolderID values can be retrieved with the GetMyMessages call with the DetailLevel value set to ReturnSummary.

In each ReviseMyMessages call, at least one of the following fields must be specified in the request: Read, Flagged, and FolderID.

Note: Messages in the Sent folder of My Messages cannot be moved, marked as read, or flagged.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
ReviseMyMessagesCall()
          Constructor.
ReviseMyMessagesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String[] getAlertIDs()
          Gets the ReviseMyMessagesRequestType.alertIDs.
 java.lang.Boolean getFlagged()
          Gets the ReviseMyMessagesRequestType.flagged.
 java.lang.Long getFolderID()
          Gets the ReviseMyMessagesRequestType.folderID.
 java.lang.String[] getMessageIDs()
          Gets the ReviseMyMessagesRequestType.messageIDs.
 java.lang.Boolean getRead()
          Gets the ReviseMyMessagesRequestType.read.
 void reviseMyMessages()
          This call can be used to mark one or more messages as 'Read', to flag one or more messages, and/or to move one or more messages to another My Messages folder.
 void setAlertIDs(java.lang.String[] alertIDs)
          Sets the ReviseMyMessagesRequestType.alertIDs.
 void setFlagged(java.lang.Boolean flagged)
          Sets the ReviseMyMessagesRequestType.flagged.
 void setFolderID(java.lang.Long folderID)
          Sets the ReviseMyMessagesRequestType.folderID.
 void setMessageIDs(java.lang.String[] messageIDs)
          Sets the ReviseMyMessagesRequestType.messageIDs.
 void setRead(java.lang.Boolean read)
          Sets the ReviseMyMessagesRequestType.read.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReviseMyMessagesCall

public ReviseMyMessagesCall()
Constructor.


ReviseMyMessagesCall

public ReviseMyMessagesCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

reviseMyMessages

public void reviseMyMessages()
                      throws ApiException,
                             SdkException,
                             java.lang.Exception
This call can be used to mark one or more messages as 'Read', to flag one or more messages, and/or to move one or more messages to another My Messages folder. Any of these actions can be applied on up to 10 messages with one call.

Throws:
ApiException
SdkException
java.lang.Exception

getAlertIDs

public java.lang.String[] getAlertIDs()
Gets the ReviseMyMessagesRequestType.alertIDs.

Returns:
String[]

setAlertIDs

public void setAlertIDs(java.lang.String[] alertIDs)
Sets the ReviseMyMessagesRequestType.alertIDs.

Parameters:
alertIDs - String[]

getFlagged

public java.lang.Boolean getFlagged()
Gets the ReviseMyMessagesRequestType.flagged.

Returns:
Boolean

setFlagged

public void setFlagged(java.lang.Boolean flagged)
Sets the ReviseMyMessagesRequestType.flagged.

Parameters:
flagged - Boolean

getFolderID

public java.lang.Long getFolderID()
Gets the ReviseMyMessagesRequestType.folderID.

Returns:
Long

setFolderID

public void setFolderID(java.lang.Long folderID)
Sets the ReviseMyMessagesRequestType.folderID.

Parameters:
folderID - Long

getMessageIDs

public java.lang.String[] getMessageIDs()
Gets the ReviseMyMessagesRequestType.messageIDs.

Returns:
String[]

setMessageIDs

public void setMessageIDs(java.lang.String[] messageIDs)
Sets the ReviseMyMessagesRequestType.messageIDs.

Parameters:
messageIDs - String[]

getRead

public java.lang.Boolean getRead()
Gets the ReviseMyMessagesRequestType.read.

Returns:
Boolean

setRead

public void setRead(java.lang.Boolean read)
Sets the ReviseMyMessagesRequestType.read.

Parameters:
read - Boolean

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.