com.vk.sdk

Class VKAccessToken

java.lang.Object

com.vk.sdk.VKAccessToken

public class VKAccessToken
extends java.lang.Object

Presents VK API access token that used for loading API methods and other stuff.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_TOKEN
java.lang.String	accessToken String token for use in request parameters
long	created Indicates time of token creation
static java.lang.String	CREATED
java.lang.String	email User email
static java.lang.String	EMAIL
static java.lang.String	EXPIRES_IN
int	expiresIn Time when token expires
static java.lang.String	HTTPS_REQUIRED
boolean	httpsRequired If user sets "Always use HTTPS" setting in his profile, it will be true
static java.lang.String	SCOPE
java.lang.String	secret User secret to sign requests (if nohttps used)
static java.lang.String	SECRET
static java.lang.String	SUCCESS
static java.lang.String	USER_ID
java.lang.String	userId Current user id for this token

Method Summary

Modifier and Type	Method and Description
VKAccessToken	copyWithToken(VKAccessToken token) Creates copy of current token, with params from passed token
static VKAccessToken	currentToken()
boolean	hasScope(java.lang.String... scopes) Return if this token contains passed permissions array
boolean	isExpired() Checks expiration time of token and returns result.
static void	removeTokenAtKey(android.content.Context ctx, java.lang.String tokenKey) Removes token from preferences with specified key
void	save() Saves this token into application shared preferences
void	saveTokenToFile(java.lang.String filePath) Save token into specified file
void	saveTokenToSharedPreferences(android.content.Context ctx, java.lang.String tokenKey) Save token into shared preferences with key
protected java.lang.String	serialize() Serialize token into string
static VKAccessToken	tokenFromFile(java.lang.String filePath) Retrieve token from file.
static VKAccessToken	tokenFromParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Retrieve token from key-value map
static VKAccessToken	tokenFromSharedPreferences(android.content.Context ctx, java.lang.String key) Retrieves token from shared preferences
static VKAccessToken	tokenFromUrlString(java.lang.String urlString) Retrieve token from key-value query string
protected java.util.Map<java.lang.String,java.lang.String>	tokenParams() Serialize token to VKParameters

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_TOKEN

public static final java.lang.String ACCESS_TOKEN

See Also:

Constant Field Values

EXPIRES_IN

public static final java.lang.String EXPIRES_IN

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

SECRET

public static final java.lang.String SECRET

See Also:

Constant Field Values

HTTPS_REQUIRED

public static final java.lang.String HTTPS_REQUIRED

See Also:

Constant Field Values

CREATED

public static final java.lang.String CREATED

See Also:

Constant Field Values

SUCCESS

public static final java.lang.String SUCCESS

See Also:

Constant Field Values

EMAIL

public static final java.lang.String EMAIL

See Also:

Constant Field Values

SCOPE

public static final java.lang.String SCOPE

See Also:

Constant Field Values

accessToken

public java.lang.String accessToken

String token for use in request parameters

expiresIn

public int expiresIn

Time when token expires

userId

public java.lang.String userId

Current user id for this token

secret

public java.lang.String secret

User secret to sign requests (if nohttps used)

httpsRequired

public boolean httpsRequired

If user sets "Always use HTTPS" setting in his profile, it will be true

created

public long created

Indicates time of token creation

email

public java.lang.String email

User email

Method Detail

saveTokenToFile

public void saveTokenToFile(java.lang.String filePath)

Save token into specified file

Parameters:

filePath - path to file with saved token

saveTokenToSharedPreferences

public void saveTokenToSharedPreferences(android.content.Context ctx,
                                         java.lang.String tokenKey)

Save token into shared preferences with key

Parameters:

ctx - Context for preferences

tokenKey - Key for saving settings

removeTokenAtKey

public static void removeTokenAtKey(android.content.Context ctx,
                                    java.lang.String tokenKey)

Removes token from preferences with specified key

Parameters:

ctx - Context for preferences

tokenKey - Key for saving settings

tokenParams

protected java.util.Map<java.lang.String,java.lang.String> tokenParams()

Serialize token to VKParameters

Returns:

serialized VKParameters value

serialize

protected java.lang.String serialize()

Serialize token into string

Returns:

Serialized token string as query-string

tokenFromUrlString

public static VKAccessToken tokenFromUrlString(java.lang.String urlString)

Retrieve token from key-value query string

Parameters:

urlString - string that contains URL-query part with token. E.g. access_token=eee&expires_in=0...

Returns:

parsed token

tokenFromParameters

public static VKAccessToken tokenFromParameters(@Nullable
                                                java.util.Map<java.lang.String,java.lang.String> parameters)

Retrieve token from key-value map

Parameters:

parameters - map that contains token info

Returns:

Parsed token

tokenFromSharedPreferences

public static VKAccessToken tokenFromSharedPreferences(android.content.Context ctx,
                                                       java.lang.String key)

Retrieves token from shared preferences

Parameters:

ctx - Context for preferences

key - Key for retrieve token

Returns:

Previously saved token or null

tokenFromFile

public static VKAccessToken tokenFromFile(java.lang.String filePath)

Retrieve token from file. Token must be saved into file with saveTokenToFile method

Parameters:

filePath - path to file with saved token

Returns:

Previously saved token or null

isExpired

public boolean isExpired()

Checks expiration time of token and returns result.

Returns:

true if token has expired, false otherwise.

currentToken

public static VKAccessToken currentToken()

Returns:

Returns shared instance of current access token

save

public void save()

Saves this token into application shared preferences

hasScope

public boolean hasScope(java.lang.String... scopes)

Return if this token contains passed permissions array

Parameters:

scopes - permissions to check

Returns:

true, if token has all of this permissions

copyWithToken

public VKAccessToken copyWithToken(@NonNull
                                   VKAccessToken token)

Creates copy of current token, with params from passed token

Parameters:

token - Usually this is partly filled access token, made after validation

Returns:

New access token with updated fields