|
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.GetMemberMessagesCall
public class GetMemberMessagesCall
Wrapper class of the GetMemberMessages 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.
ItemID
- The unique identifier of the eBay listing for which you wish to retrieve member messages.
MailMessageType
- This required field indicates the type of member message to retrieve. Only the following two enumeration values are allowed. The call will fail if this field is not included in the request.
MessageStatus
- This field allows you to retrieve only unanswered member messages or answered member messages. If this field is omitted, both answered and unanswered member messages are retrieved.
DisplayToPublic
- If included in the request and set to true
, only public messages (viewable in the Item listing) are returned. If omitted or set to false
in the request, all messages (that match other filters in the request) are returned in the response.
StartCreationTime
- Used as beginning of date range filter. If specified, filters the returned messages to only those with a creation date greater than or equal to the specified date and time.
EndCreationTime
- Used as end of date range filter. If specified, filters
the returned messages to only those with a creation date
less than or equal to the specified date and time.
Pagination
- Standard pagination argument used to reduce response.
MemberMessageID
- An ID that uniquely identifies the message for a given user to be retrieved. Used for the AskSellerQuestion notification only.
SenderID
- An eBay ID that uniquely identifies a user. For GetMemberMessages, this is the sender of the message. If included in the request, returns only messages from the specified sender.
ReturnedMemberMessages
- The returned member messages. Returned if messages that meet the request criteria exist. Note that GetMemberMessages does not return messages when, in the request, the MailMessageType is AskSellerQuestion.
PaginationResult
- Shows the pagination of data returned by requests.
HasMoreItems
- Specifies whether the response has more items.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetMemberMessagesCall()
Constructor. |
|
GetMemberMessagesCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.lang.Boolean |
getDisplayToPublic()
Gets the GetMemberMessagesRequestType.displayToPublic. |
java.util.Calendar |
getEndCreationTime()
Gets the GetMemberMessagesRequestType.endCreationTime. |
java.lang.Boolean |
getHasMoreItems()
Valid after executing the API. |
java.lang.String |
getItemID()
Gets the GetMemberMessagesRequestType.itemID. |
MessageTypeCodeType |
getMailMessageType()
Gets the GetMemberMessagesRequestType.mailMessageType. |
java.lang.String |
getMemberMessageID()
Gets the GetMemberMessagesRequestType.memberMessageID. |
MemberMessageExchangeType[] |
getMemberMessages()
Retrieves a list of the messages buyers have posted about your active item listings. |
MessageStatusTypeCodeType |
getMessageStatus()
Gets the GetMemberMessagesRequestType.messageStatus. |
PaginationType |
getPagination()
Gets the GetMemberMessagesRequestType.pagination. |
PaginationResultType |
getPaginationResult()
Valid after executing the API. |
MemberMessageExchangeType[] |
getReturnedMemberMessages()
Valid after executing the API. |
java.lang.String |
getSenderID()
Gets the GetMemberMessagesRequestType.senderID. |
java.util.Calendar |
getStartCreationTime()
Gets the GetMemberMessagesRequestType.startCreationTime. |
void |
setDisplayToPublic(java.lang.Boolean displayToPublic)
Sets the GetMemberMessagesRequestType.displayToPublic. |
void |
setEndCreationTime(java.util.Calendar endCreationTime)
Sets the GetMemberMessagesRequestType.endCreationTime. |
void |
setItemID(java.lang.String itemID)
Sets the GetMemberMessagesRequestType.itemID. |
void |
setMailMessageType(MessageTypeCodeType mailMessageType)
Sets the GetMemberMessagesRequestType.mailMessageType. |
void |
setMemberMessageID(java.lang.String memberMessageID)
Sets the GetMemberMessagesRequestType.memberMessageID. |
void |
setMessageStatus(MessageStatusTypeCodeType messageStatus)
Sets the GetMemberMessagesRequestType.messageStatus. |
void |
setPagination(PaginationType pagination)
Sets the GetMemberMessagesRequestType.pagination. |
void |
setSenderID(java.lang.String senderID)
Sets the GetMemberMessagesRequestType.senderID. |
void |
setStartCreationTime(java.util.Calendar startCreationTime)
Sets the GetMemberMessagesRequestType.startCreationTime. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetMemberMessagesCall()
public GetMemberMessagesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public MemberMessageExchangeType[] getMemberMessages() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.Boolean getDisplayToPublic()
public void setDisplayToPublic(java.lang.Boolean displayToPublic)
displayToPublic
- Booleanpublic java.util.Calendar getEndCreationTime()
public void setEndCreationTime(java.util.Calendar endCreationTime)
endCreationTime
- Calendarpublic java.lang.String getItemID()
public void setItemID(java.lang.String itemID)
itemID
- Stringpublic MessageTypeCodeType getMailMessageType()
public void setMailMessageType(MessageTypeCodeType mailMessageType)
mailMessageType
- MessageTypeCodeTypepublic java.lang.String getMemberMessageID()
public void setMemberMessageID(java.lang.String memberMessageID)
memberMessageID
- Stringpublic MessageStatusTypeCodeType getMessageStatus()
public void setMessageStatus(MessageStatusTypeCodeType messageStatus)
messageStatus
- MessageStatusTypeCodeTypepublic PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic java.lang.String getSenderID()
public void setSenderID(java.lang.String senderID)
senderID
- Stringpublic java.util.Calendar getStartCreationTime()
public void setStartCreationTime(java.util.Calendar startCreationTime)
startCreationTime
- Calendarpublic java.lang.Boolean getHasMoreItems()
public PaginationResultType getPaginationResult()
public MemberMessageExchangeType[] getReturnedMemberMessages()
|
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.