Changes since
the last release

com.ebay.sdk.call
Class ReviseMyMessagesFoldersCall

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

public class ReviseMyMessagesFoldersCall
extends ApiCall

Wrapper class of the ReviseMyMessagesFolders 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: Operation - This required field is used to indicate the type of operation to perform (add, remove, or rename a folder). See the enumeration descriptions below for more information on the usage, requirements, and limitations on each operation.
Input property: FolderID - The eBay-generated unique identifier for a custom folder in My eBay Messages. The FolderID value is required for the 'Rename' and 'Remove' operations, but not for the 'Display' (add) operation. FolderID values can be retrieved by calling GetMyMessages with a DetailLevel value set to ReturnSummary, or the FolderID value for a My eBay Messages folder can be seen at the end of the browser's URL field when you navigate to that folder in My eBay Messages.

Note: If multiple folders will be renamed with one call, the user must pay close attention to the order of the FolderID and FolderName fields, as eBay will process these requests in order according to the placement of the the FolderID and FolderName fields. So, the existing folder identified by the first FolderID field in the request payload will get renamed to the folder name passed into the first FolderName field in the request payload, and so on.
Input property: FolderName - The user-specified name of the My eBay Messages folder. The FolderName value is required for the 'Display' (add) and 'Rename' operations, but not for the 'Remove' operation. In a 'Display' (add) operation, the name passed into the FolderName field is the name of the new folder. In a 'Rename' operation, the name passed into the FolderName field will be the new name of the existing folder that is specified through the corresponding FolderID field.

FolderName values can be retrieved by calling GetMyMessages with a DetailLevel value set to ReturnSummary, or the FolderName value for a My eBay Messages folder can be seen when you navigate to My eBay Messages.

Note: If multiple folders will be renamed with one call, the user must pay close attention to the order of the FolderID and FolderName fields, as eBay will process these requests in order according to the placement of the the FolderID and FolderName fields. So, the existing folder identified by the first FolderID field in the request payload will get renamed to the folder name passed into the first FolderName field in the request payload, and so on.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
ReviseMyMessagesFoldersCall()
          Constructor.
ReviseMyMessagesFoldersCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 long[] getFolderID()
          Gets the ReviseMyMessagesFoldersRequestType.folderID.
 java.lang.String[] getFolderName()
          Gets the ReviseMyMessagesFoldersRequestType.folderName.
 MyMessagesFolderOperationCodeType getOperation()
          Gets the ReviseMyMessagesFoldersRequestType.operation.
 void reviseMyMessagesFolders()
          This call can be used to add, remove, or rename a custom folder in My eBay Messages.
 void setFolderID(long[] folderID)
          Sets the ReviseMyMessagesFoldersRequestType.folderID.
 void setFolderName(java.lang.String[] folderName)
          Sets the ReviseMyMessagesFoldersRequestType.folderName.
 void setOperation(MyMessagesFolderOperationCodeType operation)
          Sets the ReviseMyMessagesFoldersRequestType.operation.
 
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

ReviseMyMessagesFoldersCall

public ReviseMyMessagesFoldersCall()
Constructor.


ReviseMyMessagesFoldersCall

public ReviseMyMessagesFoldersCall(ApiContext apiContext)
Constructor.

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

reviseMyMessagesFolders

public void reviseMyMessagesFolders()
                             throws ApiException,
                                    SdkException,
                                    java.lang.Exception
This call can be used to add, remove, or rename a custom folder in My eBay Messages. Note that the Inbox and Sent folders cannot be removed or renamed in My eBay Messages.

A user can have up to 10 custom folders in My eBay Messages, and it is possible to add, remove, or rename up to 10 custom folders with one ReviseMyMessagesFolders call

Throws:
ApiException
SdkException
java.lang.Exception

getFolderID

public long[] getFolderID()
Gets the ReviseMyMessagesFoldersRequestType.folderID.

Returns:
long[]

setFolderID

public void setFolderID(long[] folderID)
Sets the ReviseMyMessagesFoldersRequestType.folderID.

Parameters:
folderID - long[]

getFolderName

public java.lang.String[] getFolderName()
Gets the ReviseMyMessagesFoldersRequestType.folderName.

Returns:
String[]

setFolderName

public void setFolderName(java.lang.String[] folderName)
Sets the ReviseMyMessagesFoldersRequestType.folderName.

Parameters:
folderName - String[]

getOperation

public MyMessagesFolderOperationCodeType getOperation()
Gets the ReviseMyMessagesFoldersRequestType.operation.

Returns:
MyMessagesFolderOperationCodeType

setOperation

public void setOperation(MyMessagesFolderOperationCodeType operation)
Sets the ReviseMyMessagesFoldersRequestType.operation.

Parameters:
operation - MyMessagesFolderOperationCodeType

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.