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
-
senderThe display name of the eBay user that sent the message.
property -
recipientUserIDThe displayable user ID of the recipient.
property -
sendToNameThe displayable name of the user or eBay
property
application to which the message is sent. Only
returned for M2M, and if a value exists. -
subjectThe subject of the message.
property -
messageIDAn 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. -
externalMessageIDAn 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. -
contentTypeThe content type of the body text. The three acceptable values
property
are “TEXT”, “HTML”, and “XML” (case sensitive). -
textThis 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. -
flaggedWhen 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). -
readWhether 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. -
creationDateThe date and time that a message was created by the sender.
property -
receiveDateThe date and time that a message was received by My Messages and stored in a
property
database for the recipient. -
expirationDateThe date and time at which a message expires.
property -
itemIDThe unique item ID. Not returned
property
for messages that haven’t been associated with a specific item. -
responseDetailsDetails relating to the response to a message.
property -
forwardDetailsDetails relating to the forwarding of a
property
message. Only returned if the message is
forwarded. -
folderDetails relating to a My Messages folder.
property -
contentThe 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. -
messageTypeCurrently available on the US site. Specifies the type of message being retrieved
property
through GetMyMessages. -
listingStatusSpecifies 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.
-
questionTypeCurrently available on the US site. Specifies the context of the question.
property
Corresponds to the message subject. Applies if Messages.Message.MessageType is -
repliedWhether or not a message has been replied.
property -
highPrioritySet this boolean to true to mark the message as a high-priority message.
property -
itemEndTimeThe date and time for the ended item
property -
itemTitleThe 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 *anyDiscussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_MyMessagesMessageType.hcontent
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 *contentDiscussion
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.hcontentType
The content type of the body text. The three acceptable values
are “TEXT”, “HTML”, and “XML” (case sensitive).
@property (nonatomic, retain) NSString *contentTypeDiscussion
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.hcreationDate
The date and time that a message was created by the sender.
@property (nonatomic, retain) NSDate *creationDateDiscussion
The date and time that a message was created by the sender.
type : NSDate, wrapper for primitive date
Declared In
Trading_MyMessagesMessageType.hexpirationDate
The date and time at which a message expires.
@property (nonatomic, retain) NSDate *expirationDateDiscussion
The date and time at which a message expires.
type : NSDate, wrapper for primitive date
Declared In
Trading_MyMessagesMessageType.hexternalMessageID
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 *externalMessageIDDiscussion
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.hflagged
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 *flaggedDiscussion
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.hfolder
Details relating to a My Messages folder.
@property (nonatomic, retain) Trading_MyMessagesFolderType *folderDeclared In
Trading_MyMessagesMessageType.hforwardDetails
Details relating to the forwarding of a
message. Only returned if the message is
forwarded.
@property (nonatomic, retain) Trading_MyMessagesForwardDetailsType *forwardDetailsDiscussion
Details relating to the forwarding of a
message. Only returned if the message is
forwarded.
type : class Trading_MyMessagesForwardDetailsType
Declared In
Trading_MyMessagesMessageType.hhighPriority
Set this boolean to true to mark the message as a high-priority message.
@property (nonatomic, retain) NSNumber *highPriorityDiscussion
Set this boolean to true to mark the message as a high-priority message.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_MyMessagesMessageType.hitemEndTime
The date and time for the ended item
@property (nonatomic, retain) NSDate *itemEndTimeDiscussion
The date and time for the ended item
type : NSDate, wrapper for primitive date
Declared In
Trading_MyMessagesMessageType.hitemID
The unique item ID. Not returned
for messages that haven’t been associated with a specific item.
@property (nonatomic, retain) NSString *itemIDDiscussion
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.hitemTitle
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 *itemTitleDiscussion
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.hlistingStatus
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 *listingStatusDiscussion
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.hmessageID
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 *messageIDDiscussion
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.hmessageType
Currently available on the US site. Specifies the type of message being retrieved
through GetMyMessages.
@property (nonatomic, retain) NSString *messageTypeDiscussion
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.hquestionType
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 *questionTypeDiscussion
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.hread
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 *readDiscussion
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.hreceiveDate
The date and time that a message was received by My Messages and stored in a
database for the recipient.
@property (nonatomic, retain) NSDate *receiveDateDiscussion
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.hrecipientUserID
The displayable user ID of the recipient.
@property (nonatomic, retain) NSString *recipientUserIDDiscussion
The displayable user ID of the recipient.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.hreplied
Whether or not a message has been replied.
@property (nonatomic, retain) NSNumber *repliedDiscussion
Whether or not a message has been replied.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_MyMessagesMessageType.hresponseDetails
Details relating to the response to a message.
@property (nonatomic, retain) Trading_MyMessagesResponseDetailsType *responseDetailsDiscussion
Details relating to the response to a message.
type : class Trading_MyMessagesResponseDetailsType
Declared In
Trading_MyMessagesMessageType.hsendToName
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 *sendToNameDiscussion
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.hsender
The display name of the eBay user that sent the message.
@property (nonatomic, retain) NSString *senderDiscussion
The display name of the eBay user that sent the message.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.hsubject
The subject of the message.
@property (nonatomic, retain) NSString *subjectDiscussion
The subject of the message.
type : NSString, wrapper for primitive string
Declared In
Trading_MyMessagesMessageType.htext
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 *textDiscussion
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