com.facebook

Class AccessToken

java.lang.Object

com.facebook.AccessToken

All Implemented Interfaces:

Serializable

public final class AccessToken
extends Object
implements Serializable

This class represents an access token returned by the Facebook Login service, along with associated metadata such as its expiration date and permissions. In general, the Session class will abstract away the need to worry about the details of an access token, but there are situations (such as handling native links, importing previously-obtained access tokens, etc.) where it is useful to deal with access tokens directly. Factory methods are provided to construct access tokens.

For more information on access tokens, see https://developers.facebook.com/docs/concepts/login/access-tokens-and-types/.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static AccessToken	createFromExistingAccessToken(String accessToken, Date expirationTime, Date lastRefreshTime, AccessTokenSource accessTokenSource, List<String> permissions) Creates a new AccessToken using the supplied information from a previously-obtained access token (for instance, from an already-cached access token obtained prior to integration with the Facebook SDK).
static AccessToken	createFromNativeLinkingIntent(android.content.Intent intent) Creates a new AccessToken using the information contained in an Intent populated by the Facebook application in order to launch a native link.
Date	getExpires() Gets the date at which the access token expires.
Date	getLastRefresh() Gets the date at which the token was last refreshed.
List<String>	getPermissions() Gets the list of permissions associated with this access token.
AccessTokenSource	getSource() Gets the AccessTokenSource indicating how this access token was obtained.
String	getToken() Gets the string representing the access token.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getToken

public String getToken()

Gets the string representing the access token.

Returns:

the string representing the access token

getExpires

public Date getExpires()

Gets the date at which the access token expires.

Returns:

the expiration date of the token

getPermissions

public List<String> getPermissions()

Gets the list of permissions associated with this access token. Note that the most up-to-date list of permissions is maintained by the Facebook service, so this list may be outdated if permissions have been added or removed since the time the AccessToken object was created. For more information on permissions, see https://developers.facebook.com/docs/reference/login/#permissions.

Returns:

a read-only list of strings representing the permissions granted via this access token

getSource

public AccessTokenSource getSource()

Gets the AccessTokenSource indicating how this access token was obtained.

Returns:

the enum indicating how the access token was obtained

getLastRefresh

public Date getLastRefresh()

Gets the date at which the token was last refreshed. Since tokens expire, the Facebook SDK will attempt to renew them periodically.

Returns:

the date at which this token was last refreshed

createFromExistingAccessToken

public static AccessToken createFromExistingAccessToken(String accessToken,
                                        Date expirationTime,
                                        Date lastRefreshTime,
                                        AccessTokenSource accessTokenSource,
                                        List<String> permissions)

Creates a new AccessToken using the supplied information from a previously-obtained access token (for instance, from an already-cached access token obtained prior to integration with the Facebook SDK).

Parameters:

accessToken - the access token string obtained from Facebook

expirationTime - the expiration date associated with the token; if null, an infinite expiration time is assumed (but will become correct when the token is refreshed)

lastRefreshTime - the last time the token was refreshed (or when it was first obtained); if null, the current time is used.

accessTokenSource - an enum indicating how the token was originally obtained (in most cases, this will be either AccessTokenSource.FACEBOOK_APPLICATION or AccessTokenSource.WEB_VIEW); if null, FACEBOOK_APPLICATION is assumed.

permissions - the permissions that were requested when the token was obtained (or when it was last reauthorized); may be null if permission set is unknown

Returns:

a new AccessToken

createFromNativeLinkingIntent

public static AccessToken createFromNativeLinkingIntent(android.content.Intent intent)

Creates a new AccessToken using the information contained in an Intent populated by the Facebook application in order to launch a native link. For more information on native linking, please see https://developers.facebook.com/docs/mobile/android/deep_linking/.

Parameters:

intent - the Intent that was used to start an Activity; must not be null

Returns:

a new AccessToken, or null if the Intent did not contain enough data to create one

toString

public String toString()

Overrides:

toString in class Object