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 - Contains a list of up to 10 MessageIDs MessageIDs values must be included in the request. Messages in the Sent box cannot be moved, marked as read, or flagged.
Input property: AlertIDs - This field is deprecated.
Input property: Read - Changes the read states of all messages specified in a request. At least one of the following must be specified in the request: Read, Flagged, or FolderID. Messages in the Sent box cannot be moved, marked as Read, or Flagged.

Note that messages retrieved with the API are not automatically marked Read, and must be marked Read with this call.
Input property: Flagged - Changes the flagged states of all messages specified in a request by their MessageID values. At least one of Read, Flagged, or FolderID must be specified in the request. Messages in the Sent box cannot be moved, marked as Read, or Flagged.
Input property: FolderID - An ID that uniquely identifies the My Messages folder to move messages into. At least one of the Read, Flagged, or FolderID fields must be specified in the request. Messages in the Sent box 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
 String[] getAlertIDs()
          Gets the ReviseMyMessagesRequestType.alertIDs.
 Boolean getFlagged()
          Gets the ReviseMyMessagesRequestType.flagged.
 Long getFolderID()
          Gets the ReviseMyMessagesRequestType.folderID.
 String[] getMessageIDs()
          Gets the ReviseMyMessagesRequestType.messageIDs.
 Boolean getRead()
          Gets the ReviseMyMessagesRequestType.read.
 void reviseMyMessages()
          Sets the read state for messages, sets the flagged state of messages, and moves messages into and out of folders.
 void setAlertIDs(String[] alertIDs)
          Sets the ReviseMyMessagesRequestType.alertIDs.
 void setFlagged(Boolean flagged)
          Sets the ReviseMyMessagesRequestType.flagged.
 void setFolderID(Long folderID)
          Sets the ReviseMyMessagesRequestType.folderID.
 void setMessageIDs(String[] messageIDs)
          Sets the ReviseMyMessagesRequestType.messageIDs.
 void setRead(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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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,
                             Exception
Sets the read state for messages, sets the flagged state of messages, and moves messages into and out of folders.

Throws:
ApiException
SdkException
Exception

getAlertIDs

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

Returns:
String[]

setAlertIDs

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

Parameters:
alertIDs - String[]

getFlagged

public Boolean getFlagged()
Gets the ReviseMyMessagesRequestType.flagged.

Returns:
Boolean

setFlagged

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

Parameters:
flagged - Boolean

getFolderID

public Long getFolderID()
Gets the ReviseMyMessagesRequestType.folderID.

Returns:
Long

setFolderID

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

Parameters:
folderID - Long

getMessageIDs

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

Returns:
String[]

setMessageIDs

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

Parameters:
messageIDs - String[]

getRead

public Boolean getRead()
Gets the ReviseMyMessagesRequestType.read.

Returns:
Boolean

setRead

public void setRead(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.