|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.ReviseMyMessagesFoldersCall
public class ReviseMyMessagesFoldersCall
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.
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.
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.
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.
ReturnSummary
, or the FolderName value for a My eBay Messages folder can be seen when you navigate to My eBay Messages.
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReviseMyMessagesFoldersCall()
public ReviseMyMessagesFoldersCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void reviseMyMessagesFolders() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public long[] getFolderID()
public void setFolderID(long[] folderID)
folderID
- long[]public java.lang.String[] getFolderName()
public void setFolderName(java.lang.String[] folderName)
folderName
- String[]public MyMessagesFolderOperationCodeType getOperation()
public void setOperation(MyMessagesFolderOperationCodeType operation)
operation
- MyMessagesFolderOperationCodeType
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.