Inherits from Trading_AbstractRequestType : NSObject
Declared in Trading_GetMyMessagesRequestType.h
Trading_GetMyMessagesRequestType.m

Overview

Retrieves information about the messages sent to a given user.

@ingroup EBayAPIInterface

Tasks

  •   alertIDs

    This container was deprecated with 685 release. Alerts are now synonymous
    with Flagged messages.

         property
  •   messageIDs

    Container consisting of one to 10 MessageID fields.

         property
  •   folderID

    A unique identifier for a My Messages folder. If a FolderID is provided,
    only messages from the specified folder are returned in the response.

         property
  •   startTime

    The beginning of the date-range filter.
    Filtering takes into account the entire timestamp of when messages were sent.
    Messages expire after one year.

         property
  •   endTime

    The end of the date-range filter. See StartTime
    (which is the beginning of the date-range filter).

         property
  •   externalMessageIDs

    This field is currently available on the US site. A container for IDs that
    uniquely identify messages for a given user. If provided at the time of message
    creation, this ID can be used to retrieve messages and will take precedence
    over message ID.

         property
  •   pagination

    Specifies how to create virtual pages in the returned list (such as total
    number of entries and total number of pages to return).
    Default for EntriesPerPage with GetMyMessages is 25.

         property
  •   includeHighPriorityMessageOnly

    If this field is included in the requst and set to True, only High Priority
    messages are returned in the response.

         property

Properties

alertIDs

This container was deprecated with 685 release. Alerts are now synonymous
with Flagged messages.

@property (nonatomic, retain) Trading_MyMessagesAlertIDArrayType *alertIDs

Discussion

This container was deprecated with 685 release. Alerts are now synonymous
with Flagged messages.

type : class Trading_MyMessagesAlertIDArrayType

Declared In

Trading_GetMyMessagesRequestType.h

endTime

The end of the date-range filter. See StartTime
(which is the beginning of the date-range filter).

@property (nonatomic, retain) NSDate *endTime

Discussion

The end of the date-range filter. See StartTime
(which is the beginning of the date-range filter).

type : NSDate, wrapper for primitive date

Declared In

Trading_GetMyMessagesRequestType.h

externalMessageIDs

This field is currently available on the US site. A container for IDs that
uniquely identify messages for a given user. If provided at the time of message
creation, this ID can be used to retrieve messages and will take precedence
over message ID.

@property (nonatomic, retain) Trading_MyMessagesExternalMessageIDArrayType *externalMessageIDs

Discussion

This field is currently available on the US site. A container for IDs that
uniquely identify messages for a given user. If provided at the time of message
creation, this ID can be used to retrieve messages and will take precedence
over message ID.

type : class Trading_MyMessagesExternalMessageIDArrayType

Declared In

Trading_GetMyMessagesRequestType.h

folderID

A unique identifier for a My Messages folder. If a FolderID is provided,
only messages from the specified folder are returned in the response.

@property (nonatomic, retain) NSNumber *folderID

Discussion

A unique identifier for a My Messages folder. If a FolderID is provided,
only messages from the specified folder are returned in the response.

type : NSNumber, wrapper for primitive long

Declared In

Trading_GetMyMessagesRequestType.h

includeHighPriorityMessageOnly

If this field is included in the requst and set to True, only High Priority
messages are returned in the response.

@property (nonatomic, retain) NSNumber *includeHighPriorityMessageOnly

Discussion

If this field is included in the requst and set to True, only High Priority
messages are returned in the response.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetMyMessagesRequestType.h

messageIDs

Container consisting of one to 10 MessageID fields.

@property (nonatomic, retain) Trading_MyMessagesMessageIDArrayType *messageIDs

Discussion

Container consisting of one to 10 MessageID fields.

type : class Trading_MyMessagesMessageIDArrayType

Declared In

Trading_GetMyMessagesRequestType.h

pagination

Specifies how to create virtual pages in the returned list (such as total
number of entries and total number of pages to return).
Default for EntriesPerPage with GetMyMessages is 25.

@property (nonatomic, retain) Trading_PaginationType *pagination

Discussion

Specifies how to create virtual pages in the returned list (such as total
number of entries and total number of pages to return).
Default for EntriesPerPage with GetMyMessages is 25.

type : class Trading_PaginationType

Declared In

Trading_GetMyMessagesRequestType.h

startTime

The beginning of the date-range filter.
Filtering takes into account the entire timestamp of when messages were sent.
Messages expire after one year.

@property (nonatomic, retain) NSDate *startTime

Discussion

The beginning of the date-range filter.
Filtering takes into account the entire timestamp of when messages were sent.
Messages expire after one year.

type : NSDate, wrapper for primitive date

Declared In

Trading_GetMyMessagesRequestType.h