Trading_ReviseMyMessagesRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_ReviseMyMessagesRequestType.h Trading_ReviseMyMessagesRequestType.m |
Overview
Sets the read state for messages, sets the flagged state of messages,
and moves messages into and out of folders.
@ingroup EBayAPIInterface
Tasks
-
messageIDs
Contains a list of up to 10 MessageID values.
property
MessageIDs must be included in
the request. Messages in the Sent box cannot be moved,
marked as Read, or Flagged. -
alertIDs
This field will be deprecated in an upcoming release.
property
This field formerly contained a list of up to 10 AlertID values.
Alerts cannot be flagged. Alerts cannot be
moved into a new folder until they have been resolved.
Resolve alerts by marking Read (if no action is
required), or by using ActionURL (if action is
required). -
read
Changes the read states of all
property
messages specified in a request.
At least one of the following
must be specified in the
request: Read, Flagged, or FolderID.
Messages in the Sent box cannot be moved,
marked as Read, or Flagged.
Note that messages retrieved
with the API are not automatically marked Read,
and must be marked Read with this call. -
flagged
Changes the flagged states of all messages specified in
property
a request by their MessageID values. At least one of
Read, Flagged, or FolderID must be specified in the
request. Messages in the Sent box cannot be moved,
marked as Read, or Flagged. -
folderID
An ID that uniquely identifies the My Messages folder to
property
move messages into. At least one of Read,
Flagged, or FolderID must be specified in the request.
Messages
in the Sent box cannot be moved, marked as Read, or
Flagged.
Properties
alertIDs
This field will be deprecated in an upcoming release.
This field formerly contained a list of up to 10 AlertID values.
Alerts cannot be flagged. Alerts cannot be
moved into a new folder until they have been resolved.
Resolve alerts by marking Read (if no action is
required), or by using ActionURL (if action is
required).
@property (nonatomic, retain) Trading_MyMessagesAlertIDArrayType *alertIDs
Discussion
This field will be deprecated in an upcoming release.
This field formerly contained a list of up to 10 AlertID values.
Alerts cannot be flagged. Alerts cannot be
moved into a new folder until they have been resolved.
Resolve alerts by marking Read (if no action is
required), or by using ActionURL (if action is
required).
type : class Trading_MyMessagesAlertIDArrayType
Declared In
Trading_ReviseMyMessagesRequestType.h
flagged
Changes the flagged states of all messages specified in
a request by their MessageID values. At least one of
Read, Flagged, or FolderID must be specified in the
request. Messages in the Sent box cannot be moved,
marked as Read, or Flagged.
@property (nonatomic, retain) NSNumber *flagged
Discussion
Changes the flagged states of all messages specified in
a request by their MessageID values. At least one of
Read, Flagged, or FolderID must be specified in the
request. Messages in the Sent box cannot be moved,
marked as Read, or Flagged.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ReviseMyMessagesRequestType.h
folderID
An ID that uniquely identifies the My Messages folder to
move messages into. At least one of Read,
Flagged, or FolderID must be specified in the request.
Messages
in the Sent box cannot be moved, marked as Read, or
Flagged.
@property (nonatomic, retain) NSNumber *folderID
Discussion
An ID that uniquely identifies the My Messages folder to
move messages into. At least one of Read,
Flagged, or FolderID must be specified in the request.
Messages
in the Sent box cannot be moved, marked as Read, or
Flagged.
type : NSNumber, wrapper for primitive long
Declared In
Trading_ReviseMyMessagesRequestType.h
messageIDs
Contains a list of up to 10 MessageID values.
MessageIDs must be included in
the request. Messages in the Sent box cannot be moved,
marked as Read, or Flagged.
@property (nonatomic, retain) Trading_MyMessagesMessageIDArrayType *messageIDs
Discussion
Contains a list of up to 10 MessageID values.
MessageIDs must be included in
the request. Messages in the Sent box cannot be moved,
marked as Read, or Flagged.
type : class Trading_MyMessagesMessageIDArrayType
Declared In
Trading_ReviseMyMessagesRequestType.h
read
Changes the read states of all
messages specified in a request.
At least one of the following
must be specified in the
request: Read, Flagged, or FolderID.
Messages in the Sent box cannot be moved,
marked as Read, or Flagged.
Note that messages retrieved
with the API are not automatically marked Read,
and must be marked Read with this call.
@property (nonatomic, retain) NSNumber *read
Discussion
Changes the read states of all
messages specified in a request.
At least one of the following
must be specified in the
request: Read, Flagged, or FolderID.
Messages in the Sent box cannot be moved,
marked as Read, or Flagged.
Note that messages retrieved
with the API are not automatically marked Read,
and must be marked Read with this call.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_ReviseMyMessagesRequestType.h