CustomTabsClient

@ExperimentalPendingSession
public @Nullable AuthTabSession attachAuthTabSession(@NonNull AuthTabSession.PendingSession session)

Associate AuthTabSession.PendingSession with the service and turn it into an AuthTabSession.

public @Nullable CustomTabsSession attachSession(@NonNull CustomTabsSession.PendingSession session)

Associate CustomTabsSession.PendingSession with the service and turn it into a CustomTabsSession.

public static boolean bindCustomTabsService(
    @NonNull Context context,
    @NonNull String packageName,
    @NonNull CustomTabsServiceConnection connection
)

Bind to a CustomTabsService using the given package name and ServiceConnection.

public static boolean bindCustomTabsServicePreservePriority(
    @NonNull Context context,
    @NonNull String packageName,
    @NonNull CustomTabsServiceConnection connection
)

Bind to a CustomTabsService using the given package name and ServiceConnection. This is similar to bindCustomTabsService but does not use BIND_WAIVE_PRIORITY, making it suitable for use cases where the browser is immediately going to be launched and breaking the connection would be unrecoverable.

public static boolean connectAndInitialize(@NonNull Context context, @NonNull String packageName)

Connects to the Custom Tabs warmup service, and initializes the browser. This convenience method connects to the service, and immediately warms up the Custom Tabs implementation. Since service connection is asynchronous, the return code is not the return code of warmup. This call is optional, and clients are encouraged to connect to the service, call warmup() and create a session. In this case, calling this method is not necessary.

@ExperimentalPendingSession
public static @NonNull AuthTabSession.PendingSession createPendingAuthTabSession(@NonNull Context context, int id)

Creates a new pending session without a callback. This session can be converted to a standard session using attachSession after connection.

@ExperimentalPendingSession
public static @NonNull AuthTabSession.PendingSession createPendingAuthTabSession(
    @NonNull Context context,
    int id,
    @NonNull Executor executor,
    @NonNull AuthTabCallback callback
)

Creates a new pending session with a callback. This session can be converted to a standard session using attachSession after connection.

public @Nullable Bundle extraCommand(@NonNull String commandName, @Nullable Bundle args)

Can be used as a channel between the Custom Tabs client and the provider to do something that is not part of the API yet.

public static @Nullable String getPackageName(@NonNull Context context, @Nullable List<String> packages)

Returns the preferred package to use for Custom Tabs, preferring the default VIEW handler.

public static @Nullable String getPackageName(
    @NonNull Context context,
    @Nullable List<String> packages,
    boolean ignoreDefault
)

Returns the preferred package to use for Custom Tabs. The preferred package name is the default VIEW intent handler as long as it supports Custom Tabs. To modify this preferred behavior, set ignoreDefault to true and give a non empty list of package names in packages. This method queries the PackageManager to determine which packages support the Custom Tabs API. On apps that target Android 11 and above, this requires adding the following package visibility elements to your manifest.

<!-- Place inside the <queries> element. -->
<intent>
  <action android:name="android.support.customtabs.action.CustomTabsService" />
</intent>

public static boolean isAuthTabSupported(@NonNull Context context, @NonNull String provider)

Checks whether the Custom Tabs provider supports Auth Tab. See AuthTabIntent for more information on how to launch an Auth Tab.

public static boolean isEphemeralBrowsingSupported(
    @NonNull Context context,
    @NonNull String provider
)

Checks whether the Custom Tabs provider supports Ephemeral Browsing.

public static boolean isSetNetworkSupported(@NonNull Context context, @NonNull String provider)

Check whether the Custom Tabs provider supports multi-network feature setNetwork, i.e. be able to bind a custom tab to a particular network.

public @Nullable AuthTabSession newAuthTabSession(
    @Nullable AuthTabCallback callback,
    @Nullable Executor executor
)

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.

public @Nullable AuthTabSession newAuthTabSession(
    @Nullable AuthTabCallback callback,
    @Nullable Executor executor,
    int id
)

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.

public static @NonNull CustomTabsSession.PendingSession newPendingSession(
    @NonNull Context context,
    @Nullable CustomTabsCallback callback,
    int id
)

Creates a new pending session with an optional callback. This session can be converted to a standard session using attachSession after connection. {@see PendingSession}

public @Nullable CustomTabsSession newSession(@Nullable CustomTabsCallback callback)

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.

public @Nullable CustomTabsSession newSession(@Nullable CustomTabsCallback callback, int id)

Creates a new session or updates a callback for the existing session through an ICustomTabsService. 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.

public boolean warmup(long flags)

Warm up the browser process. Allows the browser application to pre-initialize itself in the background. Significantly speeds up URL opening in the browser. This is asynchronous and can be called several times.