/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::NotificationDetailsType

NAME

eBay::API::XML::DataType::NotificationDetailsType

DESCRIPTION

Information about a single notification. Notification information includes the reference ID, notification type, current status, time delivered, error code, and error message for the notification. If notification details are included in the response, all of the detail fields are returned.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::NotificationDetailsType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setDeliveryStatus()

Returns the notification status. Possible values include Delivered, Failed, Rejected, and MarkedDown.

# Argument: 'ns:NotificationEventStateCodeType'

getDeliveryStatus()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'ns:NotificationEventStateCodeType'

setDeliveryTime()

Returns the time when the notification was delivered.

# Argument: 'xs:dateTime'

getDeliveryTime()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'xs:dateTime'

setDeliveryURL()

Returns the destination address for the notification. This is the value set using SetNotificationPreferences.

# Argument: 'xs:anyURI'

getDeliveryURL()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'xs:anyURI'

setDeliveryURLName()

Returns the delivery URL name for the notification. This is the value set using SetNotificationPreferences.

# Argument: 'xs:string'

getDeliveryURLName()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'xs:string'

setErrorMessage()

Returns the error message.

# Argument: 'xs:string'

getErrorMessage()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'xs:string'

setExpirationTime()

Date and time when this notification will be removed from the eBay system.

# Argument: 'xs:dateTime'

getExpirationTime()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'xs:dateTime'

setNextRetryTime()

Returns the time when the notification is scheduled for retry. This won't be included if the DeliveryStatus is Delivered.

# Argument: 'xs:dateTime'

getNextRetryTime()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'xs:dateTime'

setReferenceID()

Reference identifier for the notification.

# Argument: 'xs:string'

getReferenceID()

# Returns: 'xs:string'

setRetries()

Returns the total number of retries for the given notification.

# Argument: 'xs:int'

getRetries()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'xs:int'

setType()

Returns the notification type. Possible values include: AskSellerQuestion, AuctionCheckoutComplete, BestOffer, CheckoutBuyerRequestTotal, EndOfAuction, Feedback, FixedPriceEndOfTransaction, FixedPriceTransaction, ItemNotReceived, MyMessages, OutBid, SecondChanceOffer, UPIBuyerResponseDispute, UPISellerClosedDispute, UPISellerOpenedDispute, and UPISellerRespondedToDispute.

# Argument: 'ns:NotificationEventTypeCodeType'

getType()

Calls: GetNotificationsUsage
Returned: Conditionally

# Returns: 'ns:NotificationEventTypeCodeType'