Changes since
the last release

com.ebay.sdk.call
Class GetClientAlertsAuthTokenCall

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

public class GetClientAlertsAuthTokenCall
extends ApiCall

Wrapper class of the GetClientAlertsAuthToken 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.


Output property: ReturnedClientAlertsAuthToken - This token string is required for the Login call in the Client Alerts API. The Client Alerts GetUserAlerts call, which returns alerts about events associated with a specific user, requires Login.
Output property: ReturnedHardExpirationTime - A Client Alerts token expires after seven days.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetClientAlertsAuthTokenCall()
          Constructor.
GetClientAlertsAuthTokenCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 String getClientAlertsAuthToken()
          This is the base request type for the GetClientAlertsAuthToken call.
 String getReturnedClientAlertsAuthToken()
          Valid after executing the API.
 Calendar getReturnedHardExpirationTime()
          Valid after executing the API.
 
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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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

GetClientAlertsAuthTokenCall

public GetClientAlertsAuthTokenCall()
Constructor.


GetClientAlertsAuthTokenCall

public GetClientAlertsAuthTokenCall(ApiContext apiContext)
Constructor.

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

getClientAlertsAuthToken

public String getClientAlertsAuthToken()
                                throws ApiException,
                                       SdkException,
                                       Exception
This is the base request type for the GetClientAlertsAuthToken call. This call retrieves a Client Alerts token for the user, which is required when the user makes a GetUserAlerts call (Client Alerts API). a botblock token and URLs for an image or audio clip that the user is to match.

This call does not have any call-specific input parameters Retrieves a token required for the GetUserAlerts call in the Client Alerts API.

Returns:
The String object.
Throws:
ApiException
SdkException
Exception

getReturnedClientAlertsAuthToken

public String getReturnedClientAlertsAuthToken()
Valid after executing the API. Gets the returned GetClientAlertsAuthTokenResponseType.returnedClientAlertsAuthToken.

Returns:
String

getReturnedHardExpirationTime

public Calendar getReturnedHardExpirationTime()
Valid after executing the API. Gets the returned GetClientAlertsAuthTokenResponseType.returnedHardExpirationTime.

Returns:
Calendar

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.