NAME

eBay::API::XML::Call::SetNotificationPreferences::SetNotificationPreferencesRequestType

DESCRIPTION

Manages a user's notification and alerts preferences. This is part of two eBay services that update users about events on the eBay site: 1. the eBay Platform Notifications feature, and 2: the eBay Client Alerts API. Notifications and alerts are used to update production applications about selected events on the eBay site, helping reduce the number of times your application needs to retrieve certain information.

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::SetNotificationPreferences::SetNotificationPreferencesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

setApplicationDeliveryPreferences()

Specifies application-based event preferences that have been enabled, including the URL to which notifications should be delivered and whether notifications should be enabled or disabled (although the UserDeliveryPreferenceArray input property specifies specific notification subscriptions).

RequiredInput: No
#    Argument: 'ns:ApplicationDeliveryPreferencesType'

getApplicationDeliveryPreferences()

# Returns: 'ns:ApplicationDeliveryPreferencesType'

setDeliveryURLName()

For Platform Notifications, specify the name of the delivery notification URL that you want to associate with the user token specified for the SetNotificationPreferences call. If, with different SetNotificationPreferences calls, you associate multiple URL names with a single user token, each subsequent URL name overwrites the previous name associated with the user token.

RequiredInput: No
#    Argument: 'xs:string'

getDeliveryURLName()

# Returns: 'xs:string'

setEventProperty()

Characteristics or details of an event such as type, name and value. Currently can only be set for wireless applications.

RequiredInput: No
#    Argument: reference to an array  
                    of 'ns:NotificationEventPropertyType'

getEventProperty()

# Returns: reference to an array of 'ns:NotificationEventPropertyType'

setUserData()

Specifies user data for notification settings such as mobile phone number.

RequiredInput: No
#    Argument: 'ns:NotificationUserDataType'

getUserData()

# Returns: 'ns:NotificationUserDataType'

setUserDeliveryPreferenceArray()

Array of NotificationEventEnableTypes. Each NotificationEventEnableType contains an EventSetting and an EventType.

RequiredInput: No
#    Argument: 'ns:NotificationEnableArrayType'

getUserDeliveryPreferenceArray()

# Returns: 'ns:NotificationEnableArrayType'