Changes since
the last release

com.ebay.sdk.call
Class GetNotificationPreferencesCall

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

public class GetNotificationPreferencesCall
extends ApiCall

Wrapper class of the GetNotificationPreferences 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: PreferenceLevel - Specifies the type of preferences to retrieve. For example, preferences can be associated with a user, with an application, or with events.

Output property: ReturnedApplicationDeliveryPreferences - Specifies application-based event preferences that have been enabled.
Output property: ReturnedDeliveryURLName - Specifies application delivery URL Name associated with this user.
Output property: ReturnedUserDeliveryPreferenceArray - Specifies user-based event preferences that have been enabled or disabled.
Output property: UserData - Returns user data for notification settings, such as set mobile phone.
Output property: EventProperty - Contains names and values assigned to a notification event. Currently can only be set for wireless applications.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetNotificationPreferencesCall()
          Constructor.
GetNotificationPreferencesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 NotificationEventPropertyType[] getEventProperty()
          Valid after executing the API.
 GetNotificationPreferencesResponseType getNotificationPreferences()
          Retrieves the requesting application's notification preferences.
 NotificationRoleCodeType getPreferenceLevel()
          Gets the GetNotificationPreferencesRequestType.preferenceLevel.
 ApplicationDeliveryPreferencesType getReturnedApplicationDeliveryPreferences()
          Valid after executing the API.
 java.lang.String getReturnedDeliveryURLName()
          Valid after executing the API.
 NotificationEnableArrayType getReturnedUserDeliveryPreferenceArray()
          Valid after executing the API.
 NotificationUserDataType getUserData()
          Valid after executing the API.
 void setPreferenceLevel(NotificationRoleCodeType preferenceLevel)
          Sets the GetNotificationPreferencesRequestType.preferenceLevel.
 
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

GetNotificationPreferencesCall

public GetNotificationPreferencesCall()
Constructor.


GetNotificationPreferencesCall

public GetNotificationPreferencesCall(ApiContext apiContext)
Constructor.

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

getNotificationPreferences

public GetNotificationPreferencesResponseType getNotificationPreferences()
                                                                  throws ApiException,
                                                                         SdkException,
                                                                         java.lang.Exception
Retrieves the requesting application's notification preferences. Details are only returned for events for which a preference has been set. For example, if you enabled notification for the EndOfAuction event and later disabled it, the GetNotificationPreferences response would cite the EndOfAuction event preference as Disabled. Otherwise, no details would be returned regarding EndOfAuction.

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

getPreferenceLevel

public NotificationRoleCodeType getPreferenceLevel()
Gets the GetNotificationPreferencesRequestType.preferenceLevel.

Returns:
NotificationRoleCodeType

setPreferenceLevel

public void setPreferenceLevel(NotificationRoleCodeType preferenceLevel)
Sets the GetNotificationPreferencesRequestType.preferenceLevel.

Parameters:
preferenceLevel - NotificationRoleCodeType

getEventProperty

public NotificationEventPropertyType[] getEventProperty()
Valid after executing the API. Gets the returned GetNotificationPreferencesResponseType.eventProperty.

Returns:
NotificationEventPropertyType[]

getReturnedApplicationDeliveryPreferences

public ApplicationDeliveryPreferencesType getReturnedApplicationDeliveryPreferences()
Valid after executing the API. Gets the returned GetNotificationPreferencesResponseType.returnedApplicationDeliveryPreferences.

Returns:
ApplicationDeliveryPreferencesType

getReturnedDeliveryURLName

public java.lang.String getReturnedDeliveryURLName()
Valid after executing the API. Gets the returned GetNotificationPreferencesResponseType.returnedDeliveryURLName.

Returns:
String

getReturnedUserDeliveryPreferenceArray

public NotificationEnableArrayType getReturnedUserDeliveryPreferenceArray()
Valid after executing the API. Gets the returned GetNotificationPreferencesResponseType.returnedUserDeliveryPreferenceArray.

Returns:
NotificationEnableArrayType

getUserData

public NotificationUserDataType getUserData()
Valid after executing the API. Gets the returned GetNotificationPreferencesResponseType.userData.

Returns:
NotificationUserDataType

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.