arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/Authenticator

Authenticator

@JvmName(name = "AuthenticatorWithBrowserAuthenticationChallenge")
@Composable
fun Authenticator(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier, onPendingBrowserAuthenticationChallenge: (BrowserAuthenticationChallenge) -> Unit)

Displays appropriate Authentication UI when an authentication challenge is issued.

For example, when an ArcGISAuthenticationChallenge is issued and the AuthenticatorState has a corresponding OAuthUserConfiguration, then a Custom Tab will be launched to complete the OAuth sign in.

This Composable will adapt to the size of its container, allowing flexible layout usage. For alternate behavior, see DialogAuthenticator.

Since

200.8.0

Parameters

authenticatorState

the object that holds the state to handle authentication challenges.

modifier

the Modifier to apply to this Authenticator.

onPendingBrowserAuthenticationChallenge

this will be called when an authentication challenge is pending and the browser should be launched. Use this if you wish to handle browser challenges from your own activity rather than using the AuthenticationActivity, more information can be found in the Authenticator Toolkit README.

See also

@Composable
fun Authenticator(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier)

Displays appropriate Authentication UI when an authentication challenge is issued.

For example, when an ArcGISAuthenticationChallenge is issued and the AuthenticatorState has a corresponding OAuthUserConfiguration, then a Custom Tab will be launched to complete the OAuth sign in.

This Composable will adapt to the size of its container, allowing flexible layout usage. For alternate behavior, see DialogAuthenticator.

Since

200.8.0

Parameters

authenticatorState

the object that holds the state to handle authentication challenges.

modifier

the Modifier to apply to this Authenticator.

See also

@Composable
fun Authenticator(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier, onPendingOAuthUserSignIn: (OAuthUserSignIn) -> Unit? = null)

Deprecated

as of 200.8.0 and will be removed in an upcoming release, use the Authenticator composable with BrowserAuthenticationChallenge instead.

Replace with

Authenticator(AuthenticatorState, Modifier, BrowserAuthenticationChallenge)
Content copied to clipboard

Displays appropriate Authentication UI when an authentication challenge is issued.

For example, when an ArcGISAuthenticationChallenge is issued and the AuthenticatorState has a corresponding OAuthUserConfiguration, then a Custom Tab will be launched to complete the OAuth sign in.

This Composable will adapt to the size of its container, allowing flexible layout usage. For alternate behavior, see DialogAuthenticator.

Since

200.2.0

Parameters

authenticatorState

the object that holds the state to handle authentication challenges.

modifier

the Modifier to apply to this Authenticator.

onPendingOAuthUserSignIn

if not null, this will be called when an OAuth challenge is pending and the browser should be launched. Use this if you wish to handle OAuth challenges from your own activity rather than using the AuthenticationActivity.

See also