A B C D E F G H I L M N O R S U V W

A

addOnLoginStartListener(LoginStateController.OnLoginStartListener) - Method in interface com.snapchat.kit.sdk.core.controller.LoginStateController

Method to add OnLoginStartListener.

addOnLoginStateChangedListener(LoginStateController.OnLoginStateChangedListener) - Method in interface com.snapchat.kit.sdk.core.controller.LoginStateController

Method to add OnLoginStateChangedListener.

AuthTokenManager - Interface in com.snapchat.kit.sdk.core.networking

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

B

BitmojiData - Class in com.snapchat.kit.sdk.login.api.models

Model for bitmoji data related to the active (connected) user.

BitmojiData() - Constructor for class com.snapchat.kit.sdk.login.api.models.BitmojiData

BitmojiQuery - Class in com.snapchat.kit.sdk.login.api

Model to construct the query for Bitmoji data.

BitmojiQuery.Builder - Class in com.snapchat.kit.sdk.login.api

Builder for constructing the query.

build() - Method in class com.snapchat.kit.sdk.login.api.BitmojiQuery.Builder

Builds the query for requested resources.

build() - Method in class com.snapchat.kit.sdk.login.api.UserDataQuery.Builder

Builds the query for requested resources.

C

clearToken() - Method in interface com.snapchat.kit.sdk.core.networking.AuthTokenManager

Clears the local access token and refresh token, if they exist.

com.snapchat.kit.sdk - package com.snapchat.kit.sdk

com.snapchat.kit.sdk.core.controller - package com.snapchat.kit.sdk.core.controller

com.snapchat.kit.sdk.core.networking - package com.snapchat.kit.sdk.core.networking

com.snapchat.kit.sdk.login.api - package com.snapchat.kit.sdk.login.api

com.snapchat.kit.sdk.login.api.models - package com.snapchat.kit.sdk.login.api.models

com.snapchat.kit.sdk.login.models - package com.snapchat.kit.sdk.login.models

com.snapchat.kit.sdk.login.networking - package com.snapchat.kit.sdk.login.networking

D

deInitialize() - Static method in class com.snapchat.kit.sdk.SnapKit

E

errorDescription - Variable in enum com.snapchat.kit.sdk.login.api.FirebaseCustomTokenResultError

Returns the detailed description of this error.

errorDescription - Variable in enum com.snapchat.kit.sdk.login.api.UserDataResultError

Returns the detailed description of this error.

ExtensionsData - Class in com.snapchat.kit.sdk.login.api.models

Model describing the error details.

ExtensionsData() - Constructor for class com.snapchat.kit.sdk.login.api.models.ExtensionsData

ExternalUsersData - Class in com.snapchat.kit.sdk.login.models

A separate GraphQL model that holds the response for queries about other users.

ExternalUsersData() - Constructor for class com.snapchat.kit.sdk.login.models.ExternalUsersData

F

fetchUserData(UserDataQuery, UserDataResultCallback) - Method in interface com.snapchat.kit.sdk.login.api.SnapLoginApi

Method to fetch the user data based on scopes requested.

fetchUserData(Context, String, Map<String, Object>, FetchUserDataCallback) - Static method in class com.snapchat.kit.sdk.SnapLogin

Deprecated.

Use SnapLoginApi.fetchUserData(UserDataQuery, UserDataResultCallback) instead.

FetchUserDataCallback - Interface in com.snapchat.kit.sdk.login.networking

Deprecated.

fetchUserDataFromCanvasApi(String, UserDataResultCallback) - Method in class com.snapchat.kit.sdk.login.networking.SnapLoginClient

fetchUserDataFromDeprecatedApi(String, Map<String, Object>, FetchUserDataCallback) - Method in class com.snapchat.kit.sdk.login.networking.SnapLoginClient

FirebaseCustomTokenResultCallback - Interface in com.snapchat.kit.sdk.login.api

The public API interface to listen for Firebase Custom Token updates.

FirebaseCustomTokenResultError - Enum in com.snapchat.kit.sdk.login.api

Enum representing the error code for Firebase Custom Token request failure.

G

getAccessToken() - Method in interface com.snapchat.kit.sdk.core.networking.AuthTokenManager

Synchronously returns existing valid access token.

getApi(Context) - Static method in class com.snapchat.kit.sdk.SnapLogin

Method to get the Login Kit API.

getAuthTokenManager(Context) - Static method in class com.snapchat.kit.sdk.SnapLogin

Getter for AuthTokenManager.

getAvatar() - Method in class com.snapchat.kit.sdk.login.models.UserBitmojiData

Deprecated.

getAvatarId() - Method in class com.snapchat.kit.sdk.login.api.models.BitmojiData

Returns the Avatar ID of the user's bitmoji.

getBitmojiData() - Method in class com.snapchat.kit.sdk.login.api.models.MeData

Returns the Bitmoji data of the user.

getBitmojiData() - Method in class com.snapchat.kit.sdk.login.models.MeData

Deprecated.

getButton(Context, ViewGroup) - Static method in class com.snapchat.kit.sdk.SnapLogin

Method to get a standard "login" button to authenticate using Snapchat.

getButtonWithFlags(Context, ViewGroup, SnapKitFeatureOptions) - Static method in class com.snapchat.kit.sdk.SnapLogin

Method to get a standard "login" button to authenticate using Snapchat.

getData() - Method in class com.snapchat.kit.sdk.login.api.models.GraphQLResponse

Returns the data for this GraphQL response.

getDisplayName() - Method in class com.snapchat.kit.sdk.login.api.models.MeData

Returns the Display Name of the user.

getDisplayName() - Method in class com.snapchat.kit.sdk.login.models.MeData

Deprecated.

getErrorCode() - Method in class com.snapchat.kit.sdk.login.api.models.ExtensionsData

Returns the error code.

getErrors() - Method in class com.snapchat.kit.sdk.login.api.models.GraphQLResponse

Returns the list of errors for this GraphQL response.

getErrorType() - Method in class com.snapchat.kit.sdk.login.models.UserDataError

Deprecated.

getExtensionsData() - Method in class com.snapchat.kit.sdk.login.api.models.UserDataError

Returns the Extensions data of the error.

getExternalId() - Method in class com.snapchat.kit.sdk.login.api.models.MeData

Returns the External ID of the user.

getExternalId() - Method in class com.snapchat.kit.sdk.login.models.MeData

Deprecated.

getId() - Method in class com.snapchat.kit.sdk.login.models.UserBitmojiData

Deprecated.

getIdToken() - Method in class com.snapchat.kit.sdk.login.api.models.MeData

Returns the Snap OIDC (OpenID Connect) token.

getLoginStateController(Context) - Static method in class com.snapchat.kit.sdk.SnapLogin

Getter for the Login State Controller.

getMe() - Method in class com.snapchat.kit.sdk.login.models.UserData

Deprecated.

getMeData() - Method in class com.snapchat.kit.sdk.login.api.models.UserData

Returns the Me data of the user.

getMessage() - Method in class com.snapchat.kit.sdk.login.api.models.UserDataError

Returns the detailed message string of the error.

getPacksJson() - Method in class com.snapchat.kit.sdk.login.models.UserBitmojiData

Deprecated.

getPath() - Method in class com.snapchat.kit.sdk.login.api.models.UserDataError

Returns the query path which experienced the error.

getProfileLink() - Method in class com.snapchat.kit.sdk.login.models.MeData

Deprecated.

getQuery() - Method in class com.snapchat.kit.sdk.login.api.BitmojiQuery

Returns the query String.

getQuery() - Method in class com.snapchat.kit.sdk.login.api.UserDataQuery

Returns the query String.

getSelfie() - Method in class com.snapchat.kit.sdk.login.models.UserBitmojiData

Deprecated.

getTwoDAvatarUrl() - Method in class com.snapchat.kit.sdk.login.api.models.BitmojiData

Returns the 2D Avatar Url of the user's bitmoji.

getUsers() - Method in class com.snapchat.kit.sdk.login.models.ExternalUsersData

getVersion() - Static method in class com.snapchat.kit.sdk.SnapLogin

GraphQLResponse<T1,T2> - Class in com.snapchat.kit.sdk.login.api.models

Represents the general format for GraphQL responses.

GraphQLResponse() - Constructor for class com.snapchat.kit.sdk.login.api.models.GraphQLResponse

H

hasAccessToScope(String) - Method in interface com.snapchat.kit.sdk.core.networking.AuthTokenManager

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

hasError() - Method in class com.snapchat.kit.sdk.login.api.models.GraphQLResponse

Returns if this GraphQL response has any errors.

I

initSDK(Context) - Static method in class com.snapchat.kit.sdk.SnapKit

isUserLoggedIn() - Method in interface com.snapchat.kit.sdk.core.networking.AuthTokenManager

isUserLoggedIn(Context) - Static method in class com.snapchat.kit.sdk.SnapLogin

Getter to know if user is authenticated using Snapchat and has a valid auth token.

L

LoginStateController - Interface in com.snapchat.kit.sdk.core.controller

Module that provides hooks for callbacks on state changes to login.

LoginStateController.OnLoginStartListener - Interface in com.snapchat.kit.sdk.core.controller

Interface for when user has started the login request after confirm they want to approve the third party for access to the scopes listed.

LoginStateController.OnLoginStateChangedListener - Interface in com.snapchat.kit.sdk.core.controller

Interface for login state changes callbacks.

M

MeData - Class in com.snapchat.kit.sdk.login.api.models

Model for me data related to the active (connected) user.

MeData() - Constructor for class com.snapchat.kit.sdk.login.api.models.MeData

MeData - Class in com.snapchat.kit.sdk.login.models

Deprecated.

MeData() - Constructor for class com.snapchat.kit.sdk.login.models.MeData

Deprecated.

N

newBuilder() - Static method in class com.snapchat.kit.sdk.login.api.BitmojiQuery

Creates a new BitmojiQuery.Builder instance.

newBuilder() - Static method in class com.snapchat.kit.sdk.login.api.UserDataQuery

Creates a new UserDataQuery.Builder instance.

O

onFailure(FirebaseCustomTokenResultError) - Method in interface com.snapchat.kit.sdk.login.api.FirebaseCustomTokenResultCallback

Called when the Custom Token request fails.

onFailure(UserDataResultError) - Method in interface com.snapchat.kit.sdk.login.api.UserDataResultCallback

Called when the user data request fails.

onFailure(boolean, int) - Method in interface com.snapchat.kit.sdk.login.networking.FetchUserDataCallback

Deprecated.

Callback for when user data request ended in failure.

onLoginFailed() - Method in interface com.snapchat.kit.sdk.core.controller.LoginStateController.OnLoginStateChangedListener

Called when login through Snapchat failed.

onLoginStart() - Method in interface com.snapchat.kit.sdk.core.controller.LoginStateController.OnLoginStartListener

Called on user beginning the request to login after going through OAuth flow.

onLoginSucceeded() - Method in interface com.snapchat.kit.sdk.core.controller.LoginStateController.OnLoginStateChangedListener

Called when login through Snapchat has succeeded.

onLogout() - Method in interface com.snapchat.kit.sdk.core.controller.LoginStateController.OnLoginStateChangedListener

Called whenever a user explicitly logs out via AuthTokenManager#clearToken or whenever the server returns 401, requiring force logout.

onSuccess(String) - Method in interface com.snapchat.kit.sdk.login.api.FirebaseCustomTokenResultCallback

Called when the Custom Token is successfully fetched.

onSuccess(UserDataResult) - Method in interface com.snapchat.kit.sdk.login.api.UserDataResultCallback

Called when the user data is successfully fetched.

onSuccess(UserDataResponse) - Method in interface com.snapchat.kit.sdk.login.networking.FetchUserDataCallback

Deprecated.

Callback when user data is successfully fetched.

R

refreshAccessToken(RefreshAccessTokenResult) - Method in interface com.snapchat.kit.sdk.core.networking.AuthTokenManager

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

removeOnLoginStartListener(LoginStateController.OnLoginStartListener) - Method in interface com.snapchat.kit.sdk.core.controller.LoginStateController

Method to remove OnLoginStartListener.

removeOnLoginStateChangedListener(LoginStateController.OnLoginStateChangedListener) - Method in interface com.snapchat.kit.sdk.core.controller.LoginStateController

Method to remove OnLoginStateChangedListener.

S

SnapKit - Class in com.snapchat.kit.sdk

SnapLogin - Class in com.snapchat.kit.sdk

Module that handles authentication using Snapchat.

SnapLogin() - Constructor for class com.snapchat.kit.sdk.SnapLogin

SnapLoginApi - Interface in com.snapchat.kit.sdk.login.api

Public API interface for the Login Kit SDK.

SnapLoginClient - Class in com.snapchat.kit.sdk.login.networking

startFirebaseTokenGrant(FirebaseCustomTokenResultCallback) - Method in interface com.snapchat.kit.sdk.login.api.SnapLoginApi

The first step of the OAuth Flow to authenticate with Firebase using Custom Authentication System.

startTokenGrant() - Method in interface com.snapchat.kit.sdk.core.networking.AuthTokenManager

The first step of the OAuth Flow.

startTokenGrantWithOptions(SnapKitFeatureOptions) - Method in interface com.snapchat.kit.sdk.core.networking.AuthTokenManager

The first step of the OAuthFlow.

U

UserBitmojiData - Class in com.snapchat.kit.sdk.login.models

Deprecated.

UserBitmojiData() - Constructor for class com.snapchat.kit.sdk.login.models.UserBitmojiData

Deprecated.

UserData - Class in com.snapchat.kit.sdk.login.api.models

Model for user data related to the active (connected) user.

UserData() - Constructor for class com.snapchat.kit.sdk.login.api.models.UserData

UserData - Class in com.snapchat.kit.sdk.login.models

Deprecated.

UserData() - Constructor for class com.snapchat.kit.sdk.login.models.UserData

Deprecated.

UserDataError - Class in com.snapchat.kit.sdk.login.api.models

Model describing the error response.

UserDataError() - Constructor for class com.snapchat.kit.sdk.login.api.models.UserDataError

UserDataError - Class in com.snapchat.kit.sdk.login.models

Deprecated.

UserDataError() - Constructor for class com.snapchat.kit.sdk.login.models.UserDataError

Deprecated.

UserDataQuery - Class in com.snapchat.kit.sdk.login.api

Model to construct the query for fetching user data.

UserDataQuery.Builder - Class in com.snapchat.kit.sdk.login.api

Builder for constructing the query.

UserDataResponse - Class in com.snapchat.kit.sdk.login.models

Deprecated.

UserDataResponse() - Constructor for class com.snapchat.kit.sdk.login.models.UserDataResponse

Deprecated.

UserDataResult - Class in com.snapchat.kit.sdk.login.api.models

Model describing the response for the user data request.

UserDataResult() - Constructor for class com.snapchat.kit.sdk.login.api.models.UserDataResult

UserDataResultCallback - Interface in com.snapchat.kit.sdk.login.api

The public API interface to listen for user data updates.

UserDataResultError - Enum in com.snapchat.kit.sdk.login.api

Enum representing the error code for user data request failure.

V

valueOf(String) - Static method in enum com.snapchat.kit.sdk.login.api.FirebaseCustomTokenResultError

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.snapchat.kit.sdk.login.api.UserDataResultError

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.snapchat.kit.sdk.login.api.FirebaseCustomTokenResultError

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.snapchat.kit.sdk.login.api.UserDataResultError

Returns an array containing the constants of this enum type, in the order they are declared.

W

withAvatarId() - Method in class com.snapchat.kit.sdk.login.api.BitmojiQuery.Builder

For fetching the Avatar ID of the user.

withBitmoji(BitmojiQuery) - Method in class com.snapchat.kit.sdk.login.api.UserDataQuery.Builder

For fetching the 2D Avatar Url of the user.

withDisplayName() - Method in class com.snapchat.kit.sdk.login.api.UserDataQuery.Builder

For fetching the Display Name of the user.

withExternalId() - Method in class com.snapchat.kit.sdk.login.api.UserDataQuery.Builder

For fetching the External ID of the user.

withIdToken() - Method in class com.snapchat.kit.sdk.login.api.UserDataQuery.Builder

For fetching the Snap OIDC (OpenID Connect) token.

withTwoDAvatarUrl() - Method in class com.snapchat.kit.sdk.login.api.BitmojiQuery.Builder

For fetching the 2D Avatar Url of the user.

A B C D E F G H I L M N O R S U V W