vkid/com.vk.id/VKID

VKID

class VKID

VKID is the main entry point for integrating VK ID authentication into an Android application. Check readme for more information about integration steps https://github.com/VKCOM/vkid-android-sdk#readme

Properties

Link copied to clipboard
val accessToken: AccessToken?

Returns current access token or null if auth wasn't passed.

Link copied to clipboard
val refreshToken: RefreshToken?

Returns current refresh token or null if auth wasn't passed.

Functions

Link copied to clipboard
suspend fun authorize(callback: VKIDAuthCallback, params: VKIDAuthParams = VKIDAuthParams {})

Initiates the authorization process in a coroutine scope.

fun authorize(lifecycleOwner: LifecycleOwner, callback: VKIDAuthCallback, params: VKIDAuthParams = VKIDAuthParams {})

Initiates the authorization process.

Link copied to clipboard
suspend fun exchangeTokenToV2(    v1Token: String,     callback: VKIDExchangeTokenCallback,     params: VKIDExchangeTokenParams = VKIDExchangeTokenParams {})
fun exchangeTokenToV2(    lifecycleOwner: LifecycleOwner,     v1Token: String,     callback: VKIDExchangeTokenCallback,     params: VKIDExchangeTokenParams = VKIDExchangeTokenParams {})

Exchanges v1 access token to v2 access token.

Link copied to clipboard
suspend fun fetchUserData(): Result<VKIDUser?>

Fetches the user data.

Link copied to clipboard
suspend fun getUserData(callback: VKIDGetUserCallback, params: VKIDGetUserParams = VKIDGetUserParams {})
fun getUserData(lifecycleOwner: LifecycleOwner, callback: VKIDGetUserCallback, params: VKIDGetUserParams = VKIDGetUserParams {})

Fetches up-to-data user data using token from previous auth.

Link copied to clipboard
suspend fun logout(callback: VKIDLogoutCallback, params: VKIDLogoutParams = VKIDLogoutParams {})
fun logout(callback: VKIDLogoutCallback, lifecycleOwner: LifecycleOwner, params: VKIDLogoutParams = VKIDLogoutParams {})

Logs out user and invalidates the access token.

Link copied to clipboard
suspend fun refreshToken(callback: VKIDRefreshTokenCallback, params: VKIDRefreshTokenParams = VKIDRefreshTokenParams {})
fun refreshToken(    lifecycleOwner: LifecycleOwner,     callback: VKIDRefreshTokenCallback,     params: VKIDRefreshTokenParams = VKIDRefreshTokenParams {})

Initiates token refreshing.

Link copied to clipboard
fun setLocale(locale: Locale?)

Sets the language for all ui components of the SDK.