OAuthUserSignIn

data class OAuthUserSignIn

Provides data required for prompting a user for an OAuthUserCredential. Once a user has completed a sign-in prompt, the OAuth sign in is completed by calling complete or cancel depending on the result of the sign-in prompt.

Since

200.0.0

See also

Properties

Link copied to clipboard

the URL used to launch an OAuth sign in prompt in a browser

Link copied to clipboard

the OAuthUserConfiguration associated with this OAuth sign in

Functions

Link copied to clipboard
fun cancel(exception: Exception? = null)

Cancels an OAuth user sign. This results in the associated call to OAuthUserCredential.create to fail.

Link copied to clipboard
fun complete(redirectUri: String)

Completes a OAuth user sign-in with a redirect URI obtained from an OAuth prompt. The redirect URI must contain the OAuth authorization code. If the sign-in process fails to obtain a valid redirect URI, call cancel instead.