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

NAME

eBay::API::XML::DataType::SMSSubscriptionType

DESCRIPTION

User data related to notifications. Note that SMS is currently reserved for future use.

SYNOPSIS

INHERITANCE

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

Subroutines:

setCarrierID()

The wireless carrier ID.

Calls: SetNotificationPreferences
RequiredInput: No

# Argument: 'ns:WirelessCarrierIDCodeType'

getCarrierID()

Calls: GetNotificationPreferences
Returned: Conditionally

# Returns: 'ns:WirelessCarrierIDCodeType'

setErrorCode()

Reason for SMS subscription error (postback from thired-party integrator).

Calls: SetNotificationPreferences
RequiredInput: No

# Argument: 'ns:SMSSubscriptionErrorCodeCodeType'

getErrorCode()

Calls: GetNotificationPreferences
Returned: Conditionally

# Returns: 'ns:SMSSubscriptionErrorCodeCodeType'

setItemToUnsubscribe()

ID of item to unsubscribe from SMS notification.

Calls: SetNotificationPreferences
RequiredInput: No

# Argument: 'ns:ItemIDType'

getItemToUnsubscribe()

Calls: GetNotificationPreferences
Returned: Conditionally

# Returns: 'ns:ItemIDType'

setSMSPhone()

The wireless phone number to be used for receiving SMS messages. Max length of phone number varies by country.

MaxLength: varies by country

Calls: SetNotificationPreferences
RequiredInput: No

# Argument: 'xs:string'

getSMSPhone()

Calls: GetNotificationPreferences
Returned: Conditionally

# Returns: 'xs:string'

setUserStatus()

Registered/Unregistered/Pending.

Calls: SetNotificationPreferences
RequiredInput: No
AllValuesExcept: Failed, Pending, Registered, Unregistered

# Argument: 'ns:SMSSubscriptionUserStatusCodeType'

getUserStatus()

Calls: GetNotificationPreferences
Returned: Conditionally

# Returns: 'ns:SMSSubscriptionUserStatusCodeType'