Changes since
the last release

com.ebay.sdk.call
Class GetChallengeTokenCall

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

public class GetChallengeTokenCall
extends ApiCall

Wrapper class of the GetChallengeToken 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: ReturnedChallengeToken - Botblock token that is used to validate that the user is a human and not a bot.
Output property: ReturnedImageChallengeURL - The URL of the image your application should display to the user for a botblock challenge.
Output property: ReturnedAudioChallengeURL - The URL of the audio clip your application should provide for sight-impaired users. The audio clip corresponds to the image.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetChallengeTokenCall()
          Constructor.
GetChallengeTokenCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String getChallengeToken()
          This is the base request type for the GetChallengeToken call.
 java.lang.String getReturnedAudioChallengeURL()
          Valid after executing the API.
 java.lang.String getReturnedChallengeToken()
          Valid after executing the API.
 java.lang.String getReturnedImageChallengeURL()
          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, 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

GetChallengeTokenCall

public GetChallengeTokenCall()
Constructor.


GetChallengeTokenCall

public GetChallengeTokenCall(ApiContext apiContext)
Constructor.

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

getChallengeToken

public java.lang.String getChallengeToken()
                                   throws ApiException,
                                          SdkException,
                                          java.lang.Exception
This is the base request type for the GetChallengeToken call. This call retrieves 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.

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

getReturnedAudioChallengeURL

public java.lang.String getReturnedAudioChallengeURL()
Valid after executing the API. Gets the returned GetChallengeTokenResponseType.returnedAudioChallengeURL.

Returns:
String

getReturnedChallengeToken

public java.lang.String getReturnedChallengeToken()
Valid after executing the API. Gets the returned GetChallengeTokenResponseType.returnedChallengeToken.

Returns:
String

getReturnedImageChallengeURL

public java.lang.String getReturnedImageChallengeURL()
Valid after executing the API. Gets the returned GetChallengeTokenResponseType.returnedImageChallengeURL.

Returns:
String

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.