Changes since
the last release

com.ebay.sdk.call
Class GetMemberMessagesCall

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

public class GetMemberMessagesCall
extends ApiCall

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.


Input property: ItemID - The unique identifier of the eBay listing for which you wish to retrieve member messages.

For Ask Seller Question messages, the ItemID and/or a date range (specified with StartCreationTime and EndCreationTime fields), are required, or the call will fail.
Input property: 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.
Input property: 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.
Input property: 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.
Input property: 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.

For Contact eBay Member (CEM) messages, StartCreationTime and EndCreationTime must be provided.

For Ask Seller a Question (ASQ) messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included.
Input property: 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.

For Contact eBay Member (CEM) messages, StartCreationTime and EndCreationTime must be provided.

For Ask Seller a Question (ASQ) messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included.
Input property: Pagination - Standard pagination argument used to reduce response.
Input property: MemberMessageID - An ID that uniquely identifies the message for a given user to be retrieved. Used for the AskSellerQuestion notification only.
Input property: 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.
Output property: 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.
Output property: PaginationResult - Shows the pagination of data returned by requests.
Output property: HasMoreItems - Specifies whether the response has more items.

Version:
1.0
Author:
Ron Murphy

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 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

GetMemberMessagesCall

public GetMemberMessagesCall()
Constructor.


GetMemberMessagesCall

public GetMemberMessagesCall(ApiContext apiContext)
Constructor.

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

getMemberMessages

public MemberMessageExchangeType[] getMemberMessages()
                                              throws ApiException,
                                                     SdkException,
                                                     java.lang.Exception
Retrieves a list of the messages buyers have posted about your active item listings.

Returns:
The MemberMessageExchangeType[] object.
Throws:
ApiException
SdkException
java.lang.Exception

getDisplayToPublic

public java.lang.Boolean getDisplayToPublic()
Gets the GetMemberMessagesRequestType.displayToPublic.

Returns:
Boolean

setDisplayToPublic

public void setDisplayToPublic(java.lang.Boolean displayToPublic)
Sets the GetMemberMessagesRequestType.displayToPublic.

Parameters:
displayToPublic - Boolean

getEndCreationTime

public java.util.Calendar getEndCreationTime()
Gets the GetMemberMessagesRequestType.endCreationTime.

Returns:
Calendar

setEndCreationTime

public void setEndCreationTime(java.util.Calendar endCreationTime)
Sets the GetMemberMessagesRequestType.endCreationTime.

Parameters:
endCreationTime - Calendar

getItemID

public java.lang.String getItemID()
Gets the GetMemberMessagesRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the GetMemberMessagesRequestType.itemID.

Parameters:
itemID - String

getMailMessageType

public MessageTypeCodeType getMailMessageType()
Gets the GetMemberMessagesRequestType.mailMessageType.

Returns:
MessageTypeCodeType

setMailMessageType

public void setMailMessageType(MessageTypeCodeType mailMessageType)
Sets the GetMemberMessagesRequestType.mailMessageType.

Parameters:
mailMessageType - MessageTypeCodeType

getMemberMessageID

public java.lang.String getMemberMessageID()
Gets the GetMemberMessagesRequestType.memberMessageID.

Returns:
String

setMemberMessageID

public void setMemberMessageID(java.lang.String memberMessageID)
Sets the GetMemberMessagesRequestType.memberMessageID.

Parameters:
memberMessageID - String

getMessageStatus

public MessageStatusTypeCodeType getMessageStatus()
Gets the GetMemberMessagesRequestType.messageStatus.

Returns:
MessageStatusTypeCodeType

setMessageStatus

public void setMessageStatus(MessageStatusTypeCodeType messageStatus)
Sets the GetMemberMessagesRequestType.messageStatus.

Parameters:
messageStatus - MessageStatusTypeCodeType

getPagination

public PaginationType getPagination()
Gets the GetMemberMessagesRequestType.pagination.

Returns:
PaginationType

setPagination

public void setPagination(PaginationType pagination)
Sets the GetMemberMessagesRequestType.pagination.

Parameters:
pagination - PaginationType

getSenderID

public java.lang.String getSenderID()
Gets the GetMemberMessagesRequestType.senderID.

Returns:
String

setSenderID

public void setSenderID(java.lang.String senderID)
Sets the GetMemberMessagesRequestType.senderID.

Parameters:
senderID - String

getStartCreationTime

public java.util.Calendar getStartCreationTime()
Gets the GetMemberMessagesRequestType.startCreationTime.

Returns:
Calendar

setStartCreationTime

public void setStartCreationTime(java.util.Calendar startCreationTime)
Sets the GetMemberMessagesRequestType.startCreationTime.

Parameters:
startCreationTime - Calendar

getHasMoreItems

public java.lang.Boolean getHasMoreItems()
Valid after executing the API. Gets the returned GetMemberMessagesResponseType.hasMoreItems.

Returns:
Boolean

getPaginationResult

public PaginationResultType getPaginationResult()
Valid after executing the API. Gets the returned GetMemberMessagesResponseType.paginationResult.

Returns:
PaginationResultType

getReturnedMemberMessages

public MemberMessageExchangeType[] getReturnedMemberMessages()
Valid after executing the API. Gets the returned GetMemberMessagesResponseType.returnedMemberMessages.

Returns:
MemberMessageExchangeType[]

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.