Trading_GetMemberMessagesRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_GetMemberMessagesRequestType.h Trading_GetMemberMessagesRequestType.m |
Overview
Retrieves a list of the messages buyers have posted about your
active item listings.
@ingroup EBayAPIInterface
Tasks
-
itemID
The ID of the item the message is about.
property
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included. ItemID is otherwise ignored. -
mailMessageType
The type of message. Note that GetMemberMessages does not return
property
messages when this field is set to AskSellerQuestion. -
messageStatus
The status of the message.
property -
displayToPublic
If included in the request and set to True, only public messages (viewable
property
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,
property
filters the returned messages to only those with a
creation date greater than or equal to the specified
date and time.
For CEM messages, StartCreationTime and EndCreationTime
must be provided.
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included. -
endCreationTime
Used as end of date range filter. If specified, filters
property
the returned messages to only those with a creation date
less than or equal to the specified date and time.
For CEM messages, StartCreationTime and EndCreationTime
must be provided.
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included. -
pagination
Standard pagination argument used to reduce response.
property -
memberMessageID
An ID that uniquely identifies the message for a given user to be retrieved.
property
Used for the AskSellerQuestion notification only. -
senderID
An eBay ID that uniquely identifies a user. For
property
GetMemberMessages, this is the sender of the message. If
included in the request, returns only messages from the
specified sender.
Properties
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.
@property (nonatomic, retain) NSNumber *displayToPublic
Discussion
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetMemberMessagesRequestType.h
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 CEM messages, StartCreationTime and EndCreationTime
must be provided.
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included.
@property (nonatomic, retain) NSDate *endCreationTime
Discussion
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 CEM messages, StartCreationTime and EndCreationTime
must be provided.
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetMemberMessagesRequestType.h
itemID
The ID of the item the message is about.
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included. ItemID is otherwise ignored.
@property (nonatomic, retain) NSString *itemID
Discussion
The ID of the item the message is about.
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included. ItemID is otherwise ignored.
type : NSString, wrapper for primitive string
Declared In
Trading_GetMemberMessagesRequestType.h
mailMessageType
The type of message. Note that GetMemberMessages does not return
messages when this field is set to AskSellerQuestion.
@property (nonatomic, retain) NSString *mailMessageType
Discussion
The type of message. Note that GetMemberMessages does not return
messages when this field is set to AskSellerQuestion.
type: string constant in Trading_MessageTypeCodeType.h
Declared In
Trading_GetMemberMessagesRequestType.h
memberMessageID
An ID that uniquely identifies the message for a given user to be retrieved.
Used for the AskSellerQuestion notification only.
@property (nonatomic, retain) NSString *memberMessageID
Discussion
An ID that uniquely identifies the message for a given user to be retrieved.
Used for the AskSellerQuestion notification only.
type : NSString, wrapper for primitive string
Declared In
Trading_GetMemberMessagesRequestType.h
messageStatus
The status of the message.
@property (nonatomic, retain) NSString *messageStatus
Discussion
The status of the message.
type: string constant in Trading_MessageStatusTypeCodeType.h
Declared In
Trading_GetMemberMessagesRequestType.h
pagination
Standard pagination argument used to reduce response.
@property (nonatomic, retain) Trading_PaginationType *pagination
Discussion
Standard pagination argument used to reduce response.
type : class Trading_PaginationType
Declared In
Trading_GetMemberMessagesRequestType.h
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.
@property (nonatomic, retain) NSString *senderID
Discussion
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.
type : NSString, wrapper for primitive string
Declared In
Trading_GetMemberMessagesRequestType.h
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 CEM messages, StartCreationTime and EndCreationTime
must be provided.
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included.
@property (nonatomic, retain) NSDate *startCreationTime
Discussion
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 CEM messages, StartCreationTime and EndCreationTime
must be provided.
For ASQ messages, either the ItemID, or a date range
(specified with StartCreationTime and EndCreationTime),
or both must be included.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetMemberMessagesRequestType.h