Index
- NAME
- DESCRIPTION
- SYNOPSIS
- INHERITANCE
- Subroutines:
- setActionURL()
- getActionURL()
- setAlertID()
- getAlertID()
- setContentType()
- getContentType()
- setCreationDate()
- getCreationDate()
- setExpirationDate()
- getExpirationDate()
- setExternalAlertID()
- getExternalAlertID()
- setFolder()
- getFolder()
- setForwardDetails()
- getForwardDetails()
- setIsTimedResolution()
- isIsTimedResolution()
- setItemID()
- getItemID()
- setLastReadDate()
- getLastReadDate()
- setPriority()
- getPriority()
- setRead()
- isRead()
- setReceiveDate()
- getReceiveDate()
- setRecipientUserID()
- getRecipientUserID()
- setResolutionDate()
- getResolutionDate()
- setResolutionStatus()
- getResolutionStatus()
- setResponseDetails()
- getResponseDetails()
- setSender()
- getSender()
- setSubject()
- getSubject()
- setText()
- getText()
NAME
eBay::API::XML::DataType::MyMessagesAlertType
DESCRIPTION
Returns an alert header and full alert information.
SYNOPSIS
INHERITANCE
eBay::API::XML::DataType::MyMessagesAlertType inherits from the eBay::API::XML::BaseDataType class
Subroutines:
setActionURL()
A URL that the recipient must visit to resolve an alert. May be returned as an empty tag if there is no applicable URL.
# Argument: 'xs:string'
getActionURL()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:string'
setAlertID()
An ID that uniquely identifies an alert for a given user.
# Argument: 'ns:MyMessagesAlertIDType'
getAlertID()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'ns:MyMessagesAlertIDType'
setContentType()
The content type of the body text. The two acceptable values are "TEXT" and "HTML" (case sensitive).
# Argument: 'xs:string'
getContentType()
# Returns: 'xs:string'
setCreationDate()
The date and time an alert was created by a sender.
# Argument: 'xs:dateTime'
getCreationDate()
# Returns: 'xs:dateTime'
setExpirationDate()
The date and time at which an alert expires.
# Argument: 'xs:dateTime'
getExpirationDate()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:dateTime'
setExternalAlertID()
An ID used by an external application to uniquely identify an alert.
# Argument: 'xs:string'
getExternalAlertID()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders
# Returns: 'xs:string'
setFolder()
Details relating to a My Messages folder.
# Argument: 'ns:MyMessagesFolderType'
getFolder()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'ns:MyMessagesFolderType'
setForwardDetails()
Details relating to the forwarding of an alert or message. Only returned if the alert or message is forwarded.
# Argument: 'ns:MyMessagesForwardDetailsType'
getForwardDetails()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'ns:MyMessagesForwardDetailsType'
setIsTimedResolution()
Indicates whether or not a time-delayed resolution is applicable for an alert.
# Argument: 'xs:boolean'
isIsTimedResolution()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:boolean'
setItemID()
A unique eBay item ID associated with an alert.
MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
# Argument: 'ns:ItemIDType'
getItemID()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders
# Returns: 'ns:ItemIDType'
setLastReadDate()
The date and time an alert was last viewed by a given user.
# Argument: 'xs:dateTime'
getLastReadDate()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:dateTime'
setPriority()
A number ranging from 0 to 10000 (inclusive), with 10000 having the highest priority.
# Argument: 'xs:string'
getPriority()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:string'
setRead()
Whether or not an alert was viewed by a given user. Note that retrieving an alert with the API does not mark it as read.
# Argument: 'xs:boolean'
isRead()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:boolean'
setReceiveDate()
The date and time that an alert was received by My Messages and stored in a database for the recipient.
# Argument: 'xs:dateTime'
getReceiveDate()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:dateTime'
setRecipientUserID()
The displayable user ID of the recipient.
# Argument: 'xs:string'
getRecipientUserID()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:string'
setResolutionDate()
The date and time at which an alert is resolved.
# Argument: 'xs:dateTime'
getResolutionDate()
# Returns: 'xs:dateTime'
setResolutionStatus()
Whether or not an alert was resolved, and how.
# Argument: 'ns:MyMessagesAlertResolutionStatusCode'
getResolutionStatus()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'ns:MyMessagesAlertResolutionStatusCode'
setResponseDetails()
Details relating to the response to an alert or message.
# Argument: 'ns:MyMessagesResponseDetailsType'
getResponseDetails()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'ns:MyMessagesResponseDetailsType'
setSender()
The display name of the eBay application that sends the alert.
# Argument: 'xs:string'
getSender()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:string'
setSubject()
The subject of the alert.
# Argument: 'xs:string'
getSubject()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnHeaders, ReturnMessages
# Returns: 'xs:string'
setText()
The alert body. This can be either plain text or HTML, depending on which format the alert was originally written in. Note that the API does not currently check the user email format preferences that can be specified in My Messages on the eBay.com Web site.
# Argument: 'xs:string'
getText()
Calls: GetMyMessages Returned: Conditionally Details: DetailLevel: ReturnMessages
# Returns: 'xs:string'