CustomTabsService

public static final String ACTION_CUSTOM_TABS_CONNECTION = "android.support.customtabs.action.CustomTabsService"

The Intent action that a CustomTabsService must respond to.

public static final String CATEGORY_AUTH_TAB = "androidx.browser.auth.category.AuthTab"

An Intent filter category to signify that the Custom Tabs provider supports Auth Tab.

public static final String CATEGORY_COLOR_SCHEME_CUSTOMIZATION = "androidx.browser.customtabs.category.ColorSchemeCustomization"

An Intent filter category to signify that the Custom Tabs provider supports selecting and customizing color schemes via setColorScheme and setColorSchemeParams.

public static final String CATEGORY_EPHEMERAL_BROWSING = "androidx.browser.customtabs.category.EphemeralBrowsing"

An Intent filter category to signify that the Custom Tabs provider supports ephemeral browsing feature which opens Custom Tab that does not share cookies or other data with the browser that handles the Custom Tab.

public static final String CATEGORY_NAVBAR_COLOR_CUSTOMIZATION = "androidx.browser.customtabs.category.NavBarColorCustomization"

An Intent filter category to signify that the Custom Tabs provider supports customizing the color of the navigation bar (setNavigationBarColor).

public static final String CATEGORY_SET_NETWORK = "androidx.browser.customtabs.category.SetNetwork"

An Intent filter category to signify that the Custom Tabs provider supports multi-network, bind a custom tab to a particular network via setNetwork.

public static final String CATEGORY_TRUSTED_WEB_ACTIVITY_IMMERSIVE_MODE = "androidx.browser.trusted.category.ImmersiveMode"

An Intent filter category to signify that the Trusted Web Activity provider supports immersive mode.

public static final String CATEGORY_WEB_SHARE_TARGET_V2 = "androidx.browser.trusted.category.WebShareTargetV2"

An Intent filter category to signify that the Trusted Web Activity provider supports sending shared data according to the Web Share Target v2 protocol defined in https://wicg.github.io/web-share-target/level-2/.

public static final int FILE_PURPOSE_TRUSTED_WEB_ACTIVITY_SPLASH_IMAGE = 1

A constant to be used with receiveFile indicating that the file is a splash image to be shown on top of a Trusted Web Activity while the web contents are loading.

public static final String KEY_SUCCESS = "androidx.browser.customtabs.SUCCESS"

The key to use to store a boolean in the returns bundle of extraCommand method, to indicate the command is executed successfully.

public static final String KEY_URL = "android.support.customtabs.otherurls.URL"

For mayLaunchUrl calls that wants to specify more than one url, this key can be used with putParcelable to insert a new url to each bundle inside list of bundles.

public static final int RELATION_HANDLE_ALL_URLS = 2

Used for validateRelationship. Requests the ability to handle all URLs from a given origin.

public static final int RELATION_USE_AS_ORIGIN = 1

Used for validateRelationship. For App -> Web transitions, requests the app to use the declared origin to be used as origin for the client app in the web APIs context.

public static final int RESULT_FAILURE_DISALLOWED = -1

Indicates that the postMessage request was not allowed due to a bad argument or requesting at a disallowed time like when in background.

public static final int RESULT_FAILURE_MESSAGING_ERROR = -3

Indicates that the postMessage request has failed due to an internal error on the browser message channel.

public static final int RESULT_FAILURE_REMOTE_ERROR = -2

Indicates that the postMessage request has failed due to a RemoteException .

public static final int RESULT_SUCCESS = 0

Indicates that the postMessage request was accepted.

public static final String TRUSTED_WEB_ACTIVITY_CATEGORY = "androidx.browser.trusted.category.TrustedWebActivities"

An Intent filter category to signify that the Custom Tabs provider supports Trusted Web Activities (see TrustedWebUtils for more details).

protected boolean cleanUpSession(@NonNull AuthTabSessionToken sessionToken)

Called when the client side IBinder for this AuthTabSessionToken is dead. Can also be used to clean up DeathRecipient instances allocated for the given token.

protected boolean cleanUpSession(@NonNull CustomTabsSessionToken sessionToken)

Called when the client side IBinder for this CustomTabsSessionToken is dead. Can also be used to clean up DeathRecipient instances allocated for the given token.

protected abstract @Nullable Bundle extraCommand(@NonNull String commandName, @Nullable Bundle args)

Unsupported commands that may be provided by the implementation.

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

This call can be used by implementations to add extra commands, for testing or experimental purposes. A return value of null will be used to signify that the client does not know how to handle the request. As optional best practices, KEY_SUCCESS could be use to identify that command was *successfully* handled. For example, when returning a message with result:

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

    Bundle result = service.extraCommand(commandName, args);
    if (result.getBoolean(service.KEY_SUCCESS)) {
        // Command was successfully handled
    }

protected boolean isEngagementSignalsApiAvailable(
    @NonNull CustomTabsSessionToken sessionToken,
    @NonNull Bundle extras
)

Returns whether the Engagement Signals API is available. The availability of the Engagement Signals API may change at runtime. If an EngagementSignalsCallback has been set, an onSessionEnded signal will be sent if the API becomes unavailable later.

protected abstract boolean mayLaunchUrl(
    @NonNull CustomTabsSessionToken sessionToken,
    @Nullable Uri url,
    @Nullable Bundle extras,
    @Nullable List<Bundle> otherLikelyBundles
)

Tells the browser of a likely future navigation to a URL.

The method warmup has to be called beforehand. The most likely URL has to be specified explicitly. Optionally, a list of other likely URLs can be provided. They are treated as less likely than the first one, and have to be sorted in decreasing priority order. These additional URLs may be ignored. All previous calls to this method will be deprioritized.

protected abstract boolean newSession(@NonNull CustomTabsSessionToken sessionToken)

Creates a new session through an ICustomTabsService with the optional callback. This session can be used to associate any related communication through the service with an intent and then later with a Custom Tab. The client can then send later service calls or intents to through same session-intent-Custom Tab association.

@CustomTabsService.Result
protected abstract int postMessage(
    @NonNull CustomTabsSessionToken sessionToken,
    @NonNull String message,
    @Nullable Bundle extras
)

Sends a postMessage request using the origin communicated via requestPostMessageChannel. Fails when called before notifyMessageChannelReady is received on the client side.

@ExperimentalPrefetch
protected void prefetch(
    @NonNull CustomTabsSessionToken sessionToken,
    @NonNull Uri url,
    @NonNull PrefetchOptions options
)

Request the browser to start navigational prefetch to the page that will be used for future navigations. warmup is required to be called before using this method. TODO(crbug.com/40288091): Currently, there is no caller of this API and can be removed.

@ExperimentalPrefetch
protected void prefetch(
    @NonNull CustomTabsSessionToken sessionToken,
    @NonNull List<Uri> urls,
    @NonNull PrefetchOptions options
)

Request the browser to start navigational prefetch to the page that will be used for future navigations. warmup is required to be called before using this method.

protected abstract boolean receiveFile(
    @NonNull CustomTabsSessionToken sessionToken,
    @NonNull Uri uri,
    int purpose,
    @Nullable Bundle extras
)

Receive a file from client by given Uri, e.g. in order to display a large bitmap in a Custom Tab. Prior to calling this method, the client grants a read permission to the target Custom Tabs provider via grantUriPermission. The file is read and processed (where applicable) synchronously.

protected boolean registerAuthTabSession(@NonNull AuthTabSessionToken sessionToken)

Creates a new Auth Tab session through an ICustomTabsService with the optional callback. This session can be used to associate any related communication through the service with an intent and then later with an Auth Tab. The client can then send later service calls or intents through the same session-intent-Auth Tab association.

protected abstract boolean requestPostMessageChannel(
    @NonNull CustomTabsSessionToken sessionToken,
    @NonNull Uri postMessageOrigin
)

Sends a request to create a two way postMessage channel between the client and the browser linked with the given CustomTabsSession.

protected boolean requestPostMessageChannel(
    @NonNull CustomTabsSessionToken sessionToken,
    @NonNull Uri postMessageOrigin,
    @Nullable Uri postMessageTargetOrigin,
    @NonNull Bundle extras
)

Same as above method with specifying the target origin to establish communication with.

protected boolean setEngagementSignalsCallback(
    @NonNull CustomTabsSessionToken sessionToken,
    @NonNull EngagementSignalsCallback callback,
    @NonNull Bundle extras
)

Sets an EngagementSignalsCallback to execute callbacks for events related to the user's engagement with the webpage within the tab.

protected abstract boolean updateVisuals(
    @NonNull CustomTabsSessionToken sessionToken,
    @Nullable Bundle bundle
)

Updates the visuals of custom tabs for the given session. Will only succeed if the given session matches the currently active one.

protected abstract boolean validateRelationship(
    @NonNull CustomTabsSessionToken sessionToken,
    @CustomTabsService.Relation int relation,
    @NonNull Uri origin,
    @Nullable Bundle extras
)

Request to validate a relationship between the application and an origin. If this method returns true, the validation result will be provided through onRelationshipValidationResult. Otherwise the request didn't succeed. The client must call warmup before this.

protected abstract boolean warmup(long flags)

Warms up the browser process asynchronously.