|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.FetchTokenCall
public class FetchTokenCall
Wrapper class of the FetchToken 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.
SecretID
- A value associated with the token retrieval request. SecretID is
defined by the application, and is passed in the redirect URL to the
eBay sign-in page. eBay recommends using a UUID for the secret ID
value. You must also set Username (part of the RequesterCredentials)
for the particular user of interest. SecretID and Username are not
required if SessionID is present.
SessionID
- A value associated with the token retrieval request. eBay generates the
session ID when the application makes a GetSessionID request. SessionID
is passed in the redirect URL to the eBay sign-in page. The advantage
of using SessionID is that it does not require UserID as part of the
FetchToken request. SessionID is not required if SecretID is present.
ReturnedToken
- The authentication token for the user.
HardExpirationTime
- Date and time at which the token returned in eBayAuthToken expires
and can no longer be used to authenticate the user for that application.
ReturnedRESTToken
- The REST authentication token for the user.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
FetchTokenCall()
Constructor. |
|
FetchTokenCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.lang.String |
fetchToken()
Retrieves an authentication token for a user. |
java.util.Calendar |
getHardExpirationTime()
Valid after executing the API. |
java.lang.String |
getReturnedRESTToken()
Valid after executing the API. |
java.lang.String |
getReturnedToken()
Valid after executing the API. |
java.lang.String |
getSecretID()
Gets the FetchTokenRequestType.secretID. |
java.lang.String |
getSessionID()
Gets the FetchTokenRequestType.sessionID. |
void |
setSecretID(java.lang.String secretID)
Sets the FetchTokenRequestType.secretID. |
void |
setSessionID(java.lang.String sessionID)
Sets the FetchTokenRequestType.sessionID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FetchTokenCall()
public FetchTokenCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public java.lang.String fetchToken() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.String getSecretID()
public void setSecretID(java.lang.String secretID)
secretID
- Stringpublic java.lang.String getSessionID()
public void setSessionID(java.lang.String sessionID)
sessionID
- Stringpublic java.util.Calendar getHardExpirationTime()
public java.lang.String getReturnedRESTToken()
public java.lang.String getReturnedToken()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.