|
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.GetMyMessagesCall
public class GetMyMessagesCall
Wrapper class of the GetMyMessages 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.
AlertIDs
- This container is deprecated.
MessageIDs
- This container can be used to retrieve one or more specific messages identified with their unique MessageID values. Up to 10 MessageID values can be specified with one call.
FolderID
- A unique identifier for a My Messages folder. If a FolderID value is provided,
only messages from the specified folder are returned in the response.
StartTime
- The beginning of the date-range filter.
Filtering takes into account the entire timestamp of when messages were sent.
Messages expire after one year.
EndTime
- The end of the date-range filter. See StartTime
(which is the beginning of the date-range filter).
ExternalMessageIDs
- This field is currently available on the US site. A container for IDs that
uniquely identify messages for a given user. If provided at the time of message
creation, this ID can be used to retrieve messages and will take precedence
over message ID.
Pagination
- Specifies how to create virtual pages in the returned list (such as total
number of entries and total number of pages to return).
Default value for EntriesPerPage with GetMyMessages is 25.
IncludeHighPriorityMessageOnly
- If this field is included in the request and set to true
, only High Priority messages are returned in the response.
ReturnedSummary
- Summary data for a given user's messages. This includes the numbers of new
messages, flagged messages, and total messages. The amount and type of
data returned is the same whether or not the request includes specific
Message IDs. Always/Conditionally returned logic assumes a detail level of
ReturnMessages.
ReturnedAlerts
- This container is deprecated.
ReturnedMyMessages
- This container consists of an array of one or more messages that match the search criteria in the call request.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetMyMessagesCall()
Constructor. |
|
GetMyMessagesCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.lang.String[] |
getAlertIDs()
Gets the GetMyMessagesRequestType.alertIDs. |
java.util.Calendar |
getEndTime()
Gets the GetMyMessagesRequestType.endTime. |
MyMessagesExternalMessageIDArrayType |
getExternalMessageIDs()
Gets the GetMyMessagesRequestType.externalMessageIDs. |
long |
getFolderID()
Gets the GetMyMessagesRequestType.folderID. |
java.lang.Boolean |
getIncludeHighPriorityMessageOnly()
Gets the GetMyMessagesRequestType.includeHighPriorityMessageOnly. |
java.lang.String[] |
getMessageIDs()
Gets the GetMyMessagesRequestType.messageIDs. |
void |
getMyMessages()
Retrieves information about the messages sent to a given user. |
PaginationType |
getPagination()
Gets the GetMyMessagesRequestType.pagination. |
MyMessagesAlertType[] |
getReturnedAlerts()
Valid after executing the API. |
MyMessagesMessageType[] |
getReturnedMyMessages()
Valid after executing the API. |
MyMessagesSummaryType |
getReturnedSummary()
Valid after executing the API. |
java.util.Calendar |
getStartTime()
Gets the GetMyMessagesRequestType.startTime. |
void |
setAlertIDs(java.lang.String[] alertIDs)
Sets the GetMyMessagesRequestType.alertIDs. |
void |
setEndTime(java.util.Calendar endTime)
Sets the GetMyMessagesRequestType.endTime. |
void |
setExternalMessageIDs(MyMessagesExternalMessageIDArrayType externalMessageIDs)
Sets the GetMyMessagesRequestType.externalMessageIDs. |
void |
setFolderID(long folderID)
Sets the GetMyMessagesRequestType.folderID. |
void |
setIncludeHighPriorityMessageOnly(java.lang.Boolean includeHighPriorityMessageOnly)
Sets the GetMyMessagesRequestType.includeHighPriorityMessageOnly. |
void |
setMessageIDs(java.lang.String[] messageIDs)
Sets the GetMyMessagesRequestType.messageIDs. |
void |
setPagination(PaginationType pagination)
Sets the GetMyMessagesRequestType.pagination. |
void |
setStartTime(java.util.Calendar startTime)
Sets the GetMyMessagesRequestType.startTime. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetMyMessagesCall()
public GetMyMessagesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void getMyMessages() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.String[] getAlertIDs()
public void setAlertIDs(java.lang.String[] alertIDs)
alertIDs
- String[]public java.util.Calendar getEndTime()
public void setEndTime(java.util.Calendar endTime)
endTime
- Calendarpublic MyMessagesExternalMessageIDArrayType getExternalMessageIDs()
public void setExternalMessageIDs(MyMessagesExternalMessageIDArrayType externalMessageIDs)
externalMessageIDs
- MyMessagesExternalMessageIDArrayTypepublic long getFolderID()
public void setFolderID(long folderID)
folderID
- longpublic java.lang.Boolean getIncludeHighPriorityMessageOnly()
public void setIncludeHighPriorityMessageOnly(java.lang.Boolean includeHighPriorityMessageOnly)
includeHighPriorityMessageOnly
- Booleanpublic java.lang.String[] getMessageIDs()
public void setMessageIDs(java.lang.String[] messageIDs)
messageIDs
- String[]public PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic java.util.Calendar getStartTime()
public void setStartTime(java.util.Calendar startTime)
startTime
- Calendarpublic MyMessagesAlertType[] getReturnedAlerts()
public MyMessagesMessageType[] getReturnedMyMessages()
public MyMessagesSummaryType getReturnedSummary()
|
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.