AuthTabCallback

Kotlin |Java

@ExperimentalAuthTab
public interface AuthTabCallback

A callback class for Auth Tab clients to get messages regarding events in their Auth Tabs. In the implementation, all callbacks are sent to the Executor provided by the client to newAuthTabSession or its UI thread if one is not provided.

Summary

Public methods
`abstract void`	`onExtraCallback(@NonNull String callbackName, @NonNull Bundle args)` Unsupported callbacks that may be provided by the implementation.
`abstract @NonNull Bundle`	`onExtraCallbackWithResult( @NonNull String callbackName, @NonNull Bundle args )` The same as `onExtraCallback`, except that this method allows the Auth Tab provider to return a result.
`abstract void`	`onNavigationEvent(int navigationEvent, @NonNull Bundle extras)` To be called when a navigation event happens.
`abstract void`	`onWarmupCompleted(@NonNull Bundle extras)` Called when the browser process finished warming up initiated by warmup.

Public methods

onExtraCallback

Added in 1.9.0-alpha01

abstract void onExtraCallback(@NonNull String callbackName, @NonNull Bundle args)

Unsupported callbacks that may be provided by the implementation.

Note:Clients should never rely on this callback to be called and/or to have a defined behavior, as it is entirely implementation-defined and not supported.

This can be used by implementations to add extra callbacks, for testing or experimental purposes.

Parameters
`@NonNull String callbackName`	Name of the extra callback.
`@NonNull Bundle args`	Arguments for the callback

onExtraCallbackWithResult

Added in 1.9.0-alpha01

abstract @NonNull Bundle onExtraCallbackWithResult(
    @NonNull String callbackName,
    @NonNull Bundle args
)

The same as onExtraCallback, except that this method allows the Auth Tab provider to return a result. A return value of EMPTY will be used to signify that the client does not know how to handle the callback. As optional best practices, KEY_SUCCESS could be use to identify that callback was *successfully* handled. For example, when returning a message with result:

    Bundle result = new Bundle();
    result.putString("message", message);
    if (success)
        result.putBoolean(CustomTabsService#KEY_SUCCESS, true);
    return result;

The caller side:

    Bundle result = extraCallbackWithResult(callbackName, args);
    if (result.getBoolean(CustomTabsService#KEY_SUCCESS)) {
        // callback was successfully handled
    }

onNavigationEvent

Added in 1.9.0-alpha01

abstract void onNavigationEvent(int navigationEvent, @NonNull Bundle extras)

To be called when a navigation event happens.

Parameters
`int navigationEvent`	The code corresponding to the navigation event.
`@NonNull Bundle extras`	Reserved for future use.

onWarmupCompleted

Added in 1.9.0-alpha01

abstract void onWarmupCompleted(@NonNull Bundle extras)

Called when the browser process finished warming up initiated by warmup.

Parameters
`@NonNull Bundle extras`	Reserved for future use.