com.snapchat.kit.sdk.core.networking

Interface AuthTokenManager

public interface AuthTokenManager

The module that manages the user's Auth Token credentials.

Method Summary

Modifier and Type	Method and Description
void	clearToken() Clears the local access token and refresh token, if they exist.
java.lang.String	getAccessToken() Synchronously returns existing valid access token.
boolean	hasAccessToScope(java.lang.String scope) Determines whether the user has authorized the current session to have access to resources with the requested scope.
boolean	isUserLoggedIn()
void	refreshAccessToken(com.snapchat.kit.sdk.core.networking.RefreshAccessTokenResult callback) Asynchronously attempts to obtain an access token for the current user.
void	startTokenGrant() The first step of the OAuth Flow.
void	startTokenGrantWithOptions(com.snapchat.kit.sdk.core.models.SnapKitFeatureOptions snapKitFeatureOptions) The first step of the OAuthFlow.

Method Detail

isUserLoggedIn

boolean isUserLoggedIn()

Returns:

True if user has a valid access token.

refreshAccessToken

void refreshAccessToken(com.snapchat.kit.sdk.core.networking.RefreshAccessTokenResult callback)

Asynchronously attempts to obtain an access token for the current user.

Parameters:

callback - is used to return the resulting access token or error message.

getAccessToken

@Nullable
java.lang.String getAccessToken()

Synchronously returns existing valid access token. If this function returns null, the token can be refreshed asynchronously using refreshAccessToken().

Returns:

existing non-expired access token (if exists), null otherwise.

startTokenGrant

void startTokenGrant()

The first step of the OAuth Flow. Begins the authenticating flow using OAuth.

startTokenGrantWithOptions

void startTokenGrantWithOptions(@NonNull
                                com.snapchat.kit.sdk.core.models.SnapKitFeatureOptions snapKitFeatureOptions)

The first step of the OAuthFlow. Begins the authenticating flow using OAuth with designated options.

Parameters:

snapKitFeatureOptions - The options to be included in the Snapchat login request.

hasAccessToScope

boolean hasAccessToScope(@NonNull
                         java.lang.String scope)

Determines whether the user has authorized the current session to have access to resources with the requested scope.

Parameters:

scope - The scope

Returns:

true if the current session has access to resources with the scope, false otherwise

clearToken

void clearToken()

Clears the local access token and refresh token, if they exist. If the token existed, and is cleared locally,