CustomTabsClient

@ExperimentalPendingSession
fun attachAuthTabSession(session: AuthTabSession.PendingSession): AuthTabSession?

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

fun attachSession(session: CustomTabsSession.PendingSession): CustomTabsSession?

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

java-static fun bindCustomTabsService(
    context: Context,
    packageName: String,
    connection: CustomTabsServiceConnection
): Boolean

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

java-static fun bindCustomTabsServicePreservePriority(
    context: Context,
    packageName: String,
    connection: CustomTabsServiceConnection
): Boolean

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.

java-static fun connectAndInitialize(context: Context, packageName: String): Boolean

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
java-static fun createPendingAuthTabSession(context: Context, id: Int): AuthTabSession.PendingSession

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

@ExperimentalPendingSession
java-static fun createPendingAuthTabSession(
    context: Context,
    id: Int,
    executor: Executor,
    callback: AuthTabCallback
): AuthTabSession.PendingSession

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

fun extraCommand(commandName: String, args: Bundle?): Bundle?

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.

java-static fun getPackageName(context: Context, packages: (Mutable)List<String!>?): String?

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

java-static fun getPackageName(
    context: Context,
    packages: (Mutable)List<String!>?,
    ignoreDefault: Boolean
): String?

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>

java-static fun isAuthTabSupported(context: Context, provider: String): Boolean

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

java-static fun isEphemeralBrowsingSupported(context: Context, provider: String): Boolean

Checks whether the Custom Tabs provider supports Ephemeral Browsing.

java-static fun isSetNetworkSupported(context: Context, provider: String): Boolean

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

fun newAuthTabSession(callback: AuthTabCallback?, executor: Executor?): AuthTabSession?

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.

fun newAuthTabSession(callback: AuthTabCallback?, executor: Executor?, id: Int): AuthTabSession?

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.

java-static fun newPendingSession(context: Context, callback: CustomTabsCallback?, id: Int): CustomTabsSession.PendingSession

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

fun newSession(callback: CustomTabsCallback?): CustomTabsSession?

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.

fun newSession(callback: CustomTabsCallback?, id: Int): CustomTabsSession?

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.

fun warmup(flags: Long): Boolean

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.