Changes since
the last release

com.ebay.sdk.call
Class SetNotificationPreferencesCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.SetNotificationPreferencesCall

public class SetNotificationPreferencesCall
extends ApiCall

Wrapper class of the SetNotificationPreferences call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: ApplicationDeliveryPreferences - Specifies application-level 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).
Input property: UserDeliveryPreferenceArray - Specifies events and whether or not they are enabled.
Input property: UserData - Specifies user data for notification settings, such as mobile phone number.
Input property: EventProperty - Characteristics or details of an event such as type, name and value. Currently can only be set for wireless applications.
Input property: DeliveryURLName - Specifies up to 25 ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName to associate with a user token sent in a SetNotificationPreferences request. To specify multiple DeliveryURLNames, create separate instances of ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName, and then enable up to 25 DeliveryURLNames by including them in comma-separated format in this field.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
SetNotificationPreferencesCall()
          Constructor.
SetNotificationPreferencesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 ApplicationDeliveryPreferencesType getApplicationDeliveryPreferences()
          Gets the SetNotificationPreferencesRequestType.applicationDeliveryPreferences.
 java.lang.String getDeliveryURLName()
          Gets the SetNotificationPreferencesRequestType.deliveryURLName.
 NotificationEventPropertyType[] getEventProperty()
          Gets the SetNotificationPreferencesRequestType.eventProperty.
 NotificationUserDataType getUserData()
          Gets the SetNotificationPreferencesRequestType.userData.
 NotificationEnableArrayType getUserDeliveryPreferenceArray()
          Gets the SetNotificationPreferencesRequestType.userDeliveryPreferenceArray.
 void setApplicationDeliveryPreferences(ApplicationDeliveryPreferencesType applicationDeliveryPreferences)
          Sets the SetNotificationPreferencesRequestType.applicationDeliveryPreferences.
 void setDeliveryURLName(java.lang.String deliveryURLName)
          Sets the SetNotificationPreferencesRequestType.deliveryURLName.
 void setEventProperty(NotificationEventPropertyType[] eventProperty)
          Sets the SetNotificationPreferencesRequestType.eventProperty.
 SetNotificationPreferencesResponseType setNotificationPreferences()
          Manages notification and alert preferences for applications and users.
 void setUserData(NotificationUserDataType userData)
          Sets the SetNotificationPreferencesRequestType.userData.
 void setUserDeliveryPreferenceArray(NotificationEnableArrayType userDeliveryPreferenceArray)
          Sets the SetNotificationPreferencesRequestType.userDeliveryPreferenceArray.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SetNotificationPreferencesCall

public SetNotificationPreferencesCall()
Constructor.


SetNotificationPreferencesCall

public SetNotificationPreferencesCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

setNotificationPreferences

public SetNotificationPreferencesResponseType setNotificationPreferences()
                                                                  throws ApiException,
                                                                         SdkException,
                                                                         java.lang.Exception
Manages notification and alert preferences for applications and users.

Returns:
The SetNotificationPreferencesResponseType object.
Throws:
ApiException
SdkException
java.lang.Exception

getApplicationDeliveryPreferences

public ApplicationDeliveryPreferencesType getApplicationDeliveryPreferences()
Gets the SetNotificationPreferencesRequestType.applicationDeliveryPreferences.

Returns:
ApplicationDeliveryPreferencesType

setApplicationDeliveryPreferences

public void setApplicationDeliveryPreferences(ApplicationDeliveryPreferencesType applicationDeliveryPreferences)
Sets the SetNotificationPreferencesRequestType.applicationDeliveryPreferences.

Parameters:
applicationDeliveryPreferences - ApplicationDeliveryPreferencesType

getDeliveryURLName

public java.lang.String getDeliveryURLName()
Gets the SetNotificationPreferencesRequestType.deliveryURLName.

Returns:
String

setDeliveryURLName

public void setDeliveryURLName(java.lang.String deliveryURLName)
Sets the SetNotificationPreferencesRequestType.deliveryURLName.

Parameters:
deliveryURLName - String

getEventProperty

public NotificationEventPropertyType[] getEventProperty()
Gets the SetNotificationPreferencesRequestType.eventProperty.

Returns:
NotificationEventPropertyType[]

setEventProperty

public void setEventProperty(NotificationEventPropertyType[] eventProperty)
Sets the SetNotificationPreferencesRequestType.eventProperty.

Parameters:
eventProperty - NotificationEventPropertyType[]

getUserData

public NotificationUserDataType getUserData()
Gets the SetNotificationPreferencesRequestType.userData.

Returns:
NotificationUserDataType

setUserData

public void setUserData(NotificationUserDataType userData)
Sets the SetNotificationPreferencesRequestType.userData.

Parameters:
userData - NotificationUserDataType

getUserDeliveryPreferenceArray

public NotificationEnableArrayType getUserDeliveryPreferenceArray()
Gets the SetNotificationPreferencesRequestType.userDeliveryPreferenceArray.

Returns:
NotificationEnableArrayType

setUserDeliveryPreferenceArray

public void setUserDeliveryPreferenceArray(NotificationEnableArrayType userDeliveryPreferenceArray)
Sets the SetNotificationPreferencesRequestType.userDeliveryPreferenceArray.

Parameters:
userDeliveryPreferenceArray - NotificationEnableArrayType

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.