Trading_MyMessagesMessageType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_MyMessagesMessageType.h Trading_MyMessagesMessageType.m |
Overview
Contains the message information for each message specified in
MessageIDs. The amount and type of information returned varies based on
the requested detail level.
@ingroup EBayAPIInterface
Tasks
-
sender
The display name of the eBay user that sent the message.
property -
recipientUserID
The displayable user ID of the recipient.
property -
sendToName
The displayable name of the user or eBay
property
application to which the message is sent. Only
returned for M2M, and if a value exists. -
subject
The subject of the message.
property -
messageID
An ID that uniquely identifies a message for a given user.
property
This value is not the same as the value used for the
GetMemberMessages MessageID. Use the GetMemberMessages value
(used as the GetMyMessages ExternalID) instead. -
externalMessageID
An ID used by an external application to uniquely identify a
property
message. Returned only when specified by the external
application on message creation.
This value is equivalent to the value used for MessageID in
GetMemberMessages. -
contentType
The content type of the body text. The three acceptable values
property
are “TEXT”, “HTML”, and “XML” (case sensitive). -
text
This field contains message content, and
property
can contain a threaded message.
This field can contain plain text or HTML,
depending on the format of the original message.
The API does not check the email-format preferences
in My Messages on the eBay Web site. -
flagged
When the Flagged field is true,
property
it means the message is displayed with a flag in the seller's
My Messages mailbox on eBay.
It is strongly recommended that the seller act on the message by the
specified date (or within 60 days, if not specified). -
read
Whether or not a message has been viewed by a given user. Note that retrieving
property
a message with the API does not mark it as read. -
creationDate
The date and time that a message was created by the sender.
property -
receiveDate
The date and time that a message was received by My Messages and stored in a
property
database for the recipient. -
expirationDate
The date and time at which a message expires.
property -
itemID
The unique item ID. Not returned
property
for messages that haven’t been associated with a specific item. -
responseDetails
Details relating to the response to a message.
property -
forwardDetails
Details relating to the forwarding of a
property
message. Only returned if the message is
forwarded. -
folder
Details relating to a My Messages folder.
property -
content
The message body in plain text format. The message body is displayed in plain text
property
even if the eBay user’s Preferred Email Format preference on My eBay is set to HTML.
Graphics and text formatting are dropped if the eBay user’s preference is set to
HTML. -
messageType
Currently available on the US site. Specifies the type of message being retrieved
property
through GetMyMessages. -
listingStatus
Specifies an active or ended listing’s status in eBay’s processing workflow.
property
If a listing ends with a sale (or sales), eBay needs to update the sale
details (e.g., total price and buyer/high bidder) and the final value fee.
This processing can take several minutes. If you retrieve a sold item and no
details about the buyer/high bidder are returned or no final value fee is
available, use this listing status information to determine whether eBay has
finished processing the listing.
Note:
For GetMyMessages, the listing status reflects the status of the listing at the time
the question was created. The listing status for this call must not match the listing
status returned by other calls (such as GetItemTransactions). This is returned only if
Messages.Message.MessageType is AskSellerQuestion. This tag is no longer returned
in the Sandbox environment.
-
questionType
Currently available on the US site. Specifies the context of the question.
property
Corresponds to the message subject. Applies if Messages.Message.MessageType is -
replied
Whether or not a message has been replied.
property -
highPriority
Set this boolean to true to mark the message as a high-priority message.
property -
itemEndTime
The date and time for the ended item
property -
itemTitle
The title of the item listing.
property
Note:
The maximum length of an eBay Item Title is increasing to 80 characters in
Version 735.
-
any
(public property)
property
Properties
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_MyMessagesMessageType.h
content
The message body in plain text format. The message body is displayed in plain text
even if the eBay user’s Preferred Email Format preference on My eBay is set to HTML.
Graphics and text formatting are dropped if the eBay user’s preference is set to
HTML.
@property (nonatomic, retain) NSString *content
Discussion
The message body in plain text format. The message body is displayed in plain text
even if the eBay user’s Preferred Email Format preference on My eBay is set to HTML.
Graphics and text formatting are dropped if the eBay user’s preference is set to
HTML.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
contentType
The content type of the body text. The three acceptable values
are “TEXT”, “HTML”, and “XML” (case sensitive).
@property (nonatomic, retain) NSString *contentType
Discussion
The content type of the body text. The three acceptable values
are “TEXT”, “HTML”, and “XML” (case sensitive).
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
creationDate
The date and time that a message was created by the sender.
@property (nonatomic, retain) NSDate *creationDate
Discussion
The date and time that a message was created by the sender.
type : NSDate, wrapper for primitive date
Declared In
Trading_MyMessagesMessageType.h
expirationDate
The date and time at which a message expires.
@property (nonatomic, retain) NSDate *expirationDate
Discussion
The date and time at which a message expires.
type : NSDate, wrapper for primitive date
Declared In
Trading_MyMessagesMessageType.h
externalMessageID
An ID used by an external application to uniquely identify a
message. Returned only when specified by the external
application on message creation.
This value is equivalent to the value used for MessageID in
GetMemberMessages.
@property (nonatomic, retain) NSString *externalMessageID
Discussion
An ID used by an external application to uniquely identify a
message. Returned only when specified by the external
application on message creation.
This value is equivalent to the value used for MessageID in
GetMemberMessages.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
flagged
When the Flagged field is true,
it means the message is displayed with a flag in the seller's
My Messages mailbox on eBay.
It is strongly recommended that the seller act on the message by the
specified date (or within 60 days, if not specified).
@property (nonatomic, retain) NSNumber *flagged
Discussion
When the Flagged field is true,
it means the message is displayed with a flag in the seller's
My Messages mailbox on eBay.
It is strongly recommended that the seller act on the message by the
specified date (or within 60 days, if not specified).
type : NSNumber, wrapper for primitive bool
Declared In
Trading_MyMessagesMessageType.h
folder
Details relating to a My Messages folder.
@property (nonatomic, retain) Trading_MyMessagesFolderType *folder
Declared In
Trading_MyMessagesMessageType.h
forwardDetails
Details relating to the forwarding of a
message. Only returned if the message is
forwarded.
@property (nonatomic, retain) Trading_MyMessagesForwardDetailsType *forwardDetails
Discussion
Details relating to the forwarding of a
message. Only returned if the message is
forwarded.
type : class Trading_MyMessagesForwardDetailsType
Declared In
Trading_MyMessagesMessageType.h
highPriority
Set this boolean to true to mark the message as a high-priority message.
@property (nonatomic, retain) NSNumber *highPriority
Discussion
Set this boolean to true to mark the message as a high-priority message.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_MyMessagesMessageType.h
itemEndTime
The date and time for the ended item
@property (nonatomic, retain) NSDate *itemEndTime
Discussion
The date and time for the ended item
type : NSDate, wrapper for primitive date
Declared In
Trading_MyMessagesMessageType.h
itemID
The unique item ID. Not returned
for messages that haven’t been associated with a specific item.
@property (nonatomic, retain) NSString *itemID
Discussion
The unique item ID. Not returned
for messages that haven’t been associated with a specific item.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
itemTitle
The title of the item listing.
Note:
The maximum length of an eBay Item Title is increasing to 80 characters in
Version 735.
@property (nonatomic, retain) NSString *itemTitle
Discussion
The title of the item listing.
Note:
The maximum length of an eBay Item Title is increasing to 80 characters in
Version 735.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
listingStatus
Specifies an active or ended listing’s status in eBay’s processing workflow.
If a listing ends with a sale (or sales), eBay needs to update the sale
details (e.g., total price and buyer/high bidder) and the final value fee.
This processing can take several minutes. If you retrieve a sold item and no
details about the buyer/high bidder are returned or no final value fee is
available, use this listing status information to determine whether eBay has
finished processing the listing.
Note:
For GetMyMessages, the listing status reflects the status of the listing at the time
the question was created. The listing status for this call must not match the listing
status returned by other calls (such as GetItemTransactions). This is returned only if
Messages.Message.MessageType is AskSellerQuestion. This tag is no longer returned
in the Sandbox environment.
@property (nonatomic, retain) NSString *listingStatus
Discussion
Specifies an active or ended listing’s status in eBay’s processing workflow.
If a listing ends with a sale (or sales), eBay needs to update the sale
details (e.g., total price and buyer/high bidder) and the final value fee.
This processing can take several minutes. If you retrieve a sold item and no
details about the buyer/high bidder are returned or no final value fee is
available, use this listing status information to determine whether eBay has
finished processing the listing.
Note:
For GetMyMessages, the listing status reflects the status of the listing at the time
the question was created. The listing status for this call must not match the listing
status returned by other calls (such as GetItemTransactions). This is returned only if
Messages.Message.MessageType is AskSellerQuestion. This tag is no longer returned
in the Sandbox environment.
type: string constant in Trading_ListingStatusCodeType.h
Declared In
Trading_MyMessagesMessageType.h
messageID
An ID that uniquely identifies a message for a given user.
This value is not the same as the value used for the
GetMemberMessages MessageID. Use the GetMemberMessages value
(used as the GetMyMessages ExternalID) instead.
@property (nonatomic, retain) NSString *messageID
Discussion
An ID that uniquely identifies a message for a given user.
This value is not the same as the value used for the
GetMemberMessages MessageID. Use the GetMemberMessages value
(used as the GetMyMessages ExternalID) instead.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
messageType
Currently available on the US site. Specifies the type of message being retrieved
through GetMyMessages.
@property (nonatomic, retain) NSString *messageType
Discussion
Currently available on the US site. Specifies the type of message being retrieved
through GetMyMessages.
type: string constant in Trading_MessageTypeCodeType.h
Declared In
Trading_MyMessagesMessageType.h
questionType
Currently available on the US site. Specifies the context of the question.
Corresponds to the message subject. Applies if Messages.Message.MessageType is
@property (nonatomic, retain) NSString *questionType
Discussion
Currently available on the US site. Specifies the context of the question.
Corresponds to the message subject. Applies if Messages.Message.MessageType is
type: string constant in Trading_QuestionTypeCodeType.h
Declared In
Trading_MyMessagesMessageType.h
read
Whether or not a message has been viewed by a given user. Note that retrieving
a message with the API does not mark it as read.
@property (nonatomic, retain) NSNumber *read
Discussion
Whether or not a message has been viewed by a given user. Note that retrieving
a message with the API does not mark it as read.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_MyMessagesMessageType.h
receiveDate
The date and time that a message was received by My Messages and stored in a
database for the recipient.
@property (nonatomic, retain) NSDate *receiveDate
Discussion
The date and time that a message was received by My Messages and stored in a
database for the recipient.
type : NSDate, wrapper for primitive date
Declared In
Trading_MyMessagesMessageType.h
recipientUserID
The displayable user ID of the recipient.
@property (nonatomic, retain) NSString *recipientUserID
Discussion
The displayable user ID of the recipient.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
replied
Whether or not a message has been replied.
@property (nonatomic, retain) NSNumber *replied
Discussion
Whether or not a message has been replied.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_MyMessagesMessageType.h
responseDetails
Details relating to the response to a message.
@property (nonatomic, retain) Trading_MyMessagesResponseDetailsType *responseDetails
Discussion
Details relating to the response to a message.
type : class Trading_MyMessagesResponseDetailsType
Declared In
Trading_MyMessagesMessageType.h
sendToName
The displayable name of the user or eBay
application to which the message is sent. Only
returned for M2M, and if a value exists.
@property (nonatomic, retain) NSString *sendToName
Discussion
The displayable name of the user or eBay
application to which the message is sent. Only
returned for M2M, and if a value exists.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
sender
The display name of the eBay user that sent the message.
@property (nonatomic, retain) NSString *sender
Discussion
The display name of the eBay user that sent the message.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
subject
The subject of the message.
@property (nonatomic, retain) NSString *subject
Discussion
The subject of the message.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h
text
This field contains message content, and
can contain a threaded message.
This field can contain plain text or HTML,
depending on the format of the original message.
The API does not check the email-format preferences
in My Messages on the eBay Web site.
@property (nonatomic, retain) NSString *text
Discussion
This field contains message content, and
can contain a threaded message.
This field can contain plain text or HTML,
depending on the format of the original message.
The API does not check the email-format preferences
in My Messages on the eBay Web site.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.h