AuthTabIntent

Kotlin |Java

class AuthTabIntent

Class holding an Intent and other data necessary to start an Auth Tab Activity.

Create an instance of this class using the Builder and then call launch to present the auth page to the user.

Upon completion of the auth flow, the webpage should redirect to a URL with the custom scheme or an HTTPS URL with the host and path provided to the launch method.

Before starting the auth flow, you should create an ActivityResultLauncher using registerActivityResultLauncher. This launcher should be created unconditionally before every fragment or activity creation. The ActivityResultCallback provided to the launcher will be called with the result of the authentication flow, indicating success or failure.

If using an HTTPS redirect URL, you need to establish that your app and the redirect URL are owned by the same organization using Digital Asset Links. If the verification fails, the Auth Tab will return an AuthResult with the result code RESULT_VERIFICATION_FAILED.

Code sample:

// In your activity
private final ActivityResultLauncher<Intent> mLauncher =
            AuthTabIntent.registerActivityResultLauncher(this, this::handleAuthResult);

private void handleAuthResult(AuthTabIntent.AuthResult result) {
    // Check the result code
    boolean success = result.resultCode == AuthTabIntent.RESULT_OK;
    String message =
            getResources()
                    .getString(success ? R.string.auth_tab_success : R.string.auth_tab_failure);
    // Retrieve the result Uri
    message += " uri: " + result.resultUri;
    Toast.makeText(this, message, Toast.LENGTH_LONG).show();
}

...

private void launchAuthTab() {
    AuthTabIntent authTabIntent = new AuthTabIntent.Builder().build();
    authTabIntent.launch(mLauncher, Uri.parse("https://www.example.com/auth"), "myscheme");
}

...

Note: The constants below are public for the browser implementation's benefit. You are strongly encouraged to use AuthTabIntent.Builder.

Summary

Nested types
`class AuthTabIntent.AuthResult` Class containing Auth Tab result data.
`class AuthTabIntent.Builder` Builder class for `AuthTabIntent` objects.

Constants
`const String!`	`EXTRA_HTTPS_REDIRECT_HOST = "androidx.browser.auth.extra.HTTPS_REDIRECT_HOST"` String extra that determines the host of the https redirect.
`const String!`	`EXTRA_HTTPS_REDIRECT_PATH = "androidx.browser.auth.extra.HTTPS_REDIRECT_PATH"` String extra that determines the path of the https redirect.
`const String!`	`EXTRA_LAUNCH_AUTH_TAB = "androidx.browser.auth.extra.LAUNCH_AUTH_TAB"` Boolean extra that triggers an Auth Tab launch.
`const String!`	`EXTRA_REDIRECT_SCHEME = "androidx.browser.auth.extra.REDIRECT_SCHEME"` String extra that determines the redirect scheme.
`const Int`	`RESULT_CANCELED = 0` Result code for when the Auth Tab is closed without the user completing the auth flow, e.g. the user clicked the close button.
`const Int`	`RESULT_OK = -1` Result code for when the Auth Tab is closed as a result of the expected redirect, implying the auth flow was completed.
`const Int`	`RESULT_UNKNOWN_CODE = -2` Result code for when the Auth Tab implementation returns an invalid or unknown result.
`const Int`	`RESULT_VERIFICATION_FAILED = 2` Result code for when the Auth Tab is closed because the verification of the ownership of the HTTPS redirect URL failed.
`const Int`	`RESULT_VERIFICATION_TIMED_OUT = 3` Result code for when the Auth Tab is closed because the verification of the ownership of the HTTPS redirect URL couldn't be completed in a reasonable amount of time.

Public functions
`Bitmap?`	`getCloseButtonIcon()` Returns the close button icon `Bitmap`.
`java-static AuthTabColorSchemeParams`	`getColorSchemeParams( intent: Intent, colorScheme: @IntRange(from = 1, to = 2) Int )` Retrieves the instance of `AuthTabColorSchemeParams` from an `Intent` for a given color scheme.
`AuthTabSession.PendingSession?`	`@ExperimentalPendingSession getPendingSession()`
`AuthTabSession?`	`getSession()`
`Boolean`	`@ExperimentalEphemeralBrowsing isEphemeralBrowsingEnabled()` Returns whether ephemeral browsing is enabled.
`Unit`	`launch( launcher: ActivityResultLauncher<Intent!>, url: Uri, redirectScheme: String )` Launches an Auth Tab Activity.
`Unit`	`launch( launcher: ActivityResultLauncher<Intent!>, url: Uri, redirectHost: String, redirectPath: String )` Launches an Auth Tab Activity.
`java-static ActivityResultLauncher<Intent!>`	`registerActivityResultLauncher( caller: ActivityResultCaller, callback: ActivityResultCallback<AuthTabIntent.AuthResult!> )` Registers a request to launch an Auth Tab and returns an `ActivityResultLauncher` that can be used to launch it.

Public properties
`Intent`	`intent` An `Intent` used to start the Auth Tab Activity.

Parameters
`intent: Intent`	`Intent` to retrieve the color scheme params from.
`colorScheme: @IntRange(from = 1, to = 2) Int`	A constant representing a color scheme. Must not be COLOR_SCHEME_SYSTEM.

Parameters
`launcher: ActivityResultLauncher<Intent!>`	The `ActivityResultLauncher` used to launch the Auth Tab. Use `registerActivityResultLauncher` to create this. See the class documentation for more details.
`url: Uri`	The url to load in the Auth Tab.
`redirectScheme: String`	The scheme of the resulting redirect.

Parameters
`caller: ActivityResultCaller`	An `ActivityResultCaller`, e.g. a `androidx.activity.ComponentActivity` or a `androidx.fragment.app.Fragment`.
`callback: ActivityResultCallback<AuthTabIntent.AuthResult!>`	An `ActivityResultCallback` to be called with the auth result.

AuthTabIntent

Summary

Nested types

Constants

Public functions

Public properties

Constants

EXTRA_HTTPS_REDIRECT_HOST

EXTRA_HTTPS_REDIRECT_PATH

EXTRA_LAUNCH_AUTH_TAB

EXTRA_REDIRECT_SCHEME

RESULT_CANCELED

RESULT_OK

RESULT_UNKNOWN_CODE

RESULT_VERIFICATION_FAILED

RESULT_VERIFICATION_TIMED_OUT

Public functions

getCloseButtonIcon

getColorSchemeParams

getPendingSession

getSession

isEphemeralBrowsingEnabled

launch

launch

registerActivityResultLauncher

Public properties

intent