eBay::API::XML::Call::GetMyMessages::GetMyMessagesResponseType(3)

NAME
eBay::API::XML::Call::GetMyMessages::GetMyMessagesResponseType

DESCRIPTION
Conains information about the messages and alerts sent to a given user. Depending on the detail level, this information can include message and alert counts, resolution and flagged status, message and/or alert headers, and message and/or alert body text.

SYNOPSIS

INHERITANCE
eBay::API::XML::Call::GetMyMessages::GetMyMessagesResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

  setAlerts()
Contains the alert information for each alert specified in AlertIDs. The amount and type of information returned varies based on the requested detail level. Contains one MyMessagesAlertType object per alert. Returned as an empty node if user has no alerts.

# Argument: 'ns:MyMessagesAlertArrayType'

  getAlerts()
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages
#    Returns: 'ns:MyMessagesAlertArrayType'

  setMessages()
Contains the message information for each message specified in MessageIDs. The amount and type of information returned varies based on the requested detail level. Contains one MyMessagesMessageType object per message. Returned as an empty node if user has no messages.

# Argument: 'ns:MyMessagesMessageArrayType'

  getMessages()
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages
#    Returns: 'ns:MyMessagesMessageArrayType'

  setSummary()
Summary data for a given user's alerts and messages. This includes the numbers of new alerts and messages, unresolved alerts, flagged messages, and total alerts and messages. The amount and type of data returned is the same whether or not the request included specific AlertID or MessageID values. Always/Conditionally returned logic assumes a detail level of ReturnMessages.

# Argument: 'ns:MyMessagesSummaryType'

  getSummary()
  Returned: Conditionally
  Details: DetailLevel: ReturnSummary
#    Returns: 'ns:MyMessagesSummaryType'