/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::MemberMessageType

NAME

eBay::API::XML::DataType::MemberMessageType

DESCRIPTION

Container for individual message information.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::MemberMessageType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setBody()

Message content.

MaxLength: 1000

Calls: AddMemberMessageAAQToPartner
       AddMemberMessageRTQ
       AddMemberMessagesAAQToBidder
RequiredInput: Yes

# Argument: 'xs:string'

getBody()

Calls: GetAdFormatLeads
Returned: Conditionally
Details: DetailLevel: ReturnAll

Calls: GetMemberMessages
Returned: Conditionally

# Returns: 'xs:string'

setDisplayToPublic()

Specifies if the body should be displayed to the public.

Calls: AddMemberMessageRTQ
RequiredInput: No

# Argument: 'xs:boolean'

isDisplayToPublic()

Calls: GetMemberMessages
Returned: Conditionally

# Returns: 'xs:boolean'

setEmailCopyToSender()

Specifies whether or not to email a copy of the message to the sender. If omitted, this defaults to whatever the user set in preferences.

Default: omitted

Calls: AddMemberMessageAAQToPartner
       AddMemberMessageRTQ
       AddMemberMessagesAAQToBidder
RequiredInput: No

# Argument: 'xs:boolean'

isEmailCopyToSender()

# Returns: 'xs:boolean'

setHideSendersEmailAddress()

Specifies whether or not to hide sender's email address from the recipient. If omitted, this defaults to whatever the user set in preferences--or on site policy, which determines whether or not this field is recognized. <br><br> <span class="tablenote"><b>Note:</b> Starting Mid-July 2008 this tag is not operational in the Sandbox environment and is not operational in the Production environment beginning late August 2008. </span>

Default: omitted DeprecationDetails: NoOp DeprecationVersion: 579 UseInstead: Calls: AddMemberMessageAAQToPartner AddMemberMessageRTQ AddMemberMessagesAAQToBidder RequiredInput: No

# Argument: 'xs:boolean'

isHideSendersEmailAddress()

# Returns: 'xs:boolean'

setMessageID()

An ID that uniquely identifies a message for a given user. <br /><br /> This value is not the same as the value used for the GetMyMessages MessageID. However, this MessageID value can be used as the GetMyMessages ExternalID.

# Argument: 'xs:string'

getMessageID()

Calls: GetMemberMessages
Returned: Conditionally

# Returns: 'xs:string'

setMessageType()

The type of message being retrieved. Note that some message types can only be created via the eBay Web site.

Calls: AddMemberMessagesAAQToBidder
RequiredInput: Yes

# Argument: 'ns:MessageTypeCodeType'

getMessageType()

Calls: GetMemberMessages
Returned: Conditionally

# Returns: 'ns:MessageTypeCodeType'

setParentMessageID()

ID number of the question this message is responding to.

Calls: AddMemberMessageRTQ
RequiredInput: Yes

# Argument: 'xs:string'

getParentMessageID()

# Returns: 'xs:string'

setQuestionType()

The context of the question (e.g. Shipping, General).

Calls: AddMemberMessageAAQToPartner
RequiredInput: Yes

# Argument: 'ns:QuestionTypeCodeType'

getQuestionType()

Calls: GetMemberMessages
Returned: Conditionally

# Returns: 'ns:QuestionTypeCodeType'

setRecipientID()

Recipient's eBay user ID. For AddMemberMessagesAAQToBidder, must be the seller of an item, that item's bidder, or a user who has made an offer on that item via Best Offer. Note: maxOccurs is a shared schema element and needs to be unbounded for AddMemberMessagesAAQToBidder. For all other uses, there can only be one RecipientID.

Calls: AddMemberMessageAAQToPartner
       AddMemberMessageRTQ
       AddMemberMessagesAAQToBidder
RequiredInput: Yes

# Argument: reference to an array of 'xs:string'

getRecipientID()

Calls: GetMemberMessages
Returned: Conditionally

# Returns: reference to an array of 'xs:string'

setSenderEmail()

The email address of the person who asked the question or sent the message. Returned for MessageType = AskSellerQuestion and by the AskSellerQuestion notification.

# Argument: 'xs:string'

getSenderEmail()

Calls: GetMemberMessages
Returned: Conditionally
DeprecationVersion: 573

# Returns: 'xs:string'

setSenderID()

The eBay user ID of the person who asked the question or sent the message.

# Argument: 'xs:string'

getSenderID()

Calls: GetMemberMessages
Returned: Conditionally

# Returns: 'xs:string'

setSubject()

Subject of this email message.

Calls: AddMemberMessageAAQToPartner
RequiredInput: Yes

# Argument: 'xs:string'

getSubject()

Calls: GetMemberMessages
Returned: Conditionally

# Returns: 'xs:string'