# CustomTabsIntent
Artifact: [androidx.browser:browser](https://developer.android.com/jetpack/androidx/releases/browser) [View Source](https://cs.android.com/search?q=file:androidx/browser/customtabs/CustomTabsIntent.java+class:androidx.browser.customtabs.CustomTabsIntent) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
*** ** * ** ***
```
public final class CustomTabsIntent
```
*** ** * ** ***
Class holding the `https://developer.android.com/reference/android/content/Intent.html` and start bundle for a Custom Tabs Activity.
**Note:** The constants below are public for the browser implementation's benefit. You are strongly encouraged to use `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder`.
## Summary
| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder` Builder class for `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent` objects. |
| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_HEIGHT_ADJUSTABLE() = 1` The Custom Tab Activity, when it behaves as a bottom sheet, can have its height manually resized by the user. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_HEIGHT_DEFAULT() = 0` Applies the default height resize behavior for the Custom Tab Activity when it behaves as a bottom sheet. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_HEIGHT_FIXED() = 2` The Custom Tab Activity, when it behaves as a bottom sheet, cannot have its height manually resized by the user. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DEFAULT() = 0` Side sheet's default decoration type. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DIVIDER() = 3` Side sheet with a divider line - the activity is bordered by a thin opaque line. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_NONE() = 1` Side sheet with no decorations - the activity is not bordered by any shadow or divider line. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW() = 2` Side sheet with shadow decoration - the activity is bordered by a shadow effect. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_POSITION_DEFAULT() = 0` Applies the default position for the Custom Tab Activity when it behaves as a side sheet. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_POSITION_END() = 2` Position the side sheet on the end side of the screen. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_POSITION_START() = 1` Position the side sheet on the start side of the screen. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_DEFAULT() = 0` Side sheet's default rounded corner configuration. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE() = 1` Side sheet with no rounded corners. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_TOP() = 2` Side sheet with the inner top corner rounded (if positioned on the right of the screen, this will be the top left corner) |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_DEFAULT() = 0` Same as `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_START()`. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_END() = 2` Positions the close button at the end of the toolbar. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_START() = 1` Positions the close button at the start of the toolbar. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#COLOR_SCHEME_DARK() = 2` Applies a dark color scheme to the user interface in the custom tab. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#COLOR_SCHEME_LIGHT() = 1` Applies a light color scheme to the user interface in the custom tab. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#COLOR_SCHEME_SYSTEM() = 0` Applies either a light or dark color scheme to the user interface in the custom tab depending on the user's system settings. |
| `static final int` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CONTENT_TARGET_TYPE_IMAGE() = 1` Content target type: Image. |
| `static final int` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CONTENT_TARGET_TYPE_LINK() = 2` Content target type: Link. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTION_BUTTON_BUNDLE() = "android.support.customtabs.extra.ACTION_BUTTON_BUNDLE"` Bundle used for adding a custom action button to the custom tab toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_HEIGHT_RESIZE_BEHAVIOR() = "androidx.browser.customtabs.extra.ACTIVITY_HEIGHT_RESIZE_BEHAVIOR"` Extra that, if set in combination with `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_HEIGHT_PX()`, defines the height resize behavior of the Custom Tab Activity when it behaves as a bottom sheet. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_BREAKPOINT_DP() = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_BREAKPOINT_DP"` Extra that, if set, allows you to set a custom breakpoint for the Custom Tab - a value, x, for which if the screen's width is higher than x, the Custom Tab will behave as a side sheet (if `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_WIDTH_PX()` is set), otherwise it will behave as a bottom sheet (if `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_HEIGHT_PX()` is set). |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_DECORATION_TYPE() = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_DECORATION_TYPE"` Extra that, if set, allows you to set how you want to distinguish the Partial Custom Tab side sheet from the rest of the display. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION() = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION"` Extra that enables the maximization button on the side sheet Custom Tab toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_POSITION() = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_POSITION"` Extra that specifies the position of the side sheet. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION() = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION"` Extra that, if set, allows you to choose which side sheet corners should be rounded, if any at all. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CLICKED_CONTENT_TARGET_TYPE() = "androidx.browser.customtabs.extra.CLICKED_CONTENT_TARGET_TYPE"` Extra added to the `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser when a custom content action is triggered. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CLOSE_BUTTON_ENABLED() = "androidx.browser.customtabs.extra.CLOSE_BUTTON_ENABLED"` Extra that enables the close button and shows it in the toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CLOSE_BUTTON_ICON() = "android.support.customtabs.extra.CLOSE_BUTTON_ICON"` Extra bitmap that specifies the icon of the back button on the toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CLOSE_BUTTON_POSITION() = "androidx.browser.customtabs.extra.CLOSE_BUTTON_POSITION"` Extra that specifies the position of the close button on the toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_COLOR_SCHEME() = "androidx.browser.customtabs.extra.COLOR_SCHEME"` Extra (int) that specifies which color scheme should be applied to the custom tab. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_COLOR_SCHEME_PARAMS() = "androidx.browser.customtabs.extra.COLOR_SCHEME_PARAMS"` Extra that contains a SparseArray, mapping color schemes (except `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#COLOR_SCHEME_SYSTEM()`) to `https://developer.android.com/reference/android/os/Bundle.html` representing `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabColorSchemeParams`. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CONTEXT_IMAGE_ALT_TEXT() = "androidx.browser.customtabs.extra.CONTEXT_IMAGE_ALT_TEXT"` Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CONTEXT_IMAGE_DATA_URI() = "androidx.browser.customtabs.extra.CONTEXT_IMAGE_DATA_URI"` Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CONTEXT_IMAGE_URL() = "androidx.browser.customtabs.extra.CONTEXT_IMAGE_URL"` Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CONTEXT_LINK_TEXT() = "androidx.browser.customtabs.extra.CONTEXT_LINK_TEXT"` Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CONTEXT_LINK_URL() = "androidx.browser.customtabs.extra.CONTEXT_LINK_URL"` Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CUSTOM_CONTENT_ACTIONS() = "androidx.browser.customtabs.extra.CUSTOM_CONTENT_ACTIONS"` Extra for an `https://developer.android.com/reference/java/util/ArrayList.html` of `https://developer.android.com/reference/android/os/Bundle.html` objects, each representing a `https://developer.android.com/reference/androidx/browser/customtabs/CustomContentAction`. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_DEFAULT_SHARE_MENU_ITEM() = "android.support.customtabs.extra.SHARE_MENU_ITEM"` **This field is deprecated.** Use `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SHARE_STATE()` instead.
|
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_DISABLE_BACKGROUND_INTERACTION() = "androidx.browser.customtabs.extra.DISABLE_BACKGROUND_INTERACTION"` Extra tha disables interactions with the background app when a Partial Custom Tab is launched. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_DISABLE_BOOKMARKS_BUTTON() = "org.chromium.chrome.browser.customtabs.EXTRA_DISABLE_STAR_BUTTON"` Extra to disable the bookmarks button in the overflow menu. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_DISABLE_DOWNLOAD_BUTTON() = "org.chromium.chrome.browser.customtabs.EXTRA_DISABLE_DOWNLOAD_BUTTON"` Extra to disable the download button in the overflow menu. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ENABLE_EPHEMERAL_BROWSING() = "androidx.browser.customtabs.extra.ENABLE_EPHEMERAL_BROWSING"` Extra that enables ephemeral browsing within the Custom Tab. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ENABLE_INSTANT_APPS() = "android.support.customtabs.extra.EXTRA_ENABLE_INSTANT_APPS"` Extra that specifies whether Instant Apps is enabled. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ENABLE_URLBAR_HIDING() = "android.support.customtabs.extra.ENABLE_URLBAR_HIDING"` Boolean extra that enables the url bar to hide as the user scrolls down the page |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_EXIT_ANIMATION_BUNDLE() = "android.support.customtabs.extra.EXIT_ANIMATION_BUNDLE"` Bundle constructed out of `https://developer.android.com/reference/androidx/core/app/ActivityOptionsCompat` that will be running when the `https://developer.android.com/reference/android/app/Activity.html` that holds the custom tab gets finished. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_HEIGHT_PX() = "androidx.browser.customtabs.extra.INITIAL_ACTIVITY_HEIGHT_PX"` Extra that, if set, makes the Custom Tab Activity's height to be x pixels, the Custom Tab will behave as a bottom sheet. x will be clamped between 50% and 100% of screen height. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_WIDTH_PX() = "androidx.browser.customtabs.extra.INITIAL_ACTIVITY_WIDTH_PX"` Extra that, if set, makes the Custom Tab Activity's width to be x pixels, the Custom Tab will behave as a side sheet. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalInitialNavigationCanLeaveBrowser https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_NAVIGATION_CAN_LEAVE_BROWSER() = "androidx.browser.customtabs.extra.INITIAL_NAVIGATION_CAN_LEAVE_BROWSER"` Extra to favor the Custom Tab forwarding the initial URL sent to the Custom Tab to the default handling app for that URL instead of loading it (including following any redirects) in the Custom Tab. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_MENU_ITEMS() = "android.support.customtabs.extra.MENU_ITEMS"` Use an `ArrayList` for specifying menu related params. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_NAVIGATION_BAR_COLOR() = "androidx.browser.customtabs.extra.NAVIGATION_BAR_COLOR"` Extra that contains the color of the navigation bar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_NAVIGATION_BAR_DIVIDER_COLOR() = "androidx.browser.customtabs.extra.NAVIGATION_BAR_DIVIDER_COLOR"` Extra that contains the color of the navigation bar divider. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_NETWORK() = "androidx.browser.customtabs.extra.NETWORK"` Extra that specifies the `https://developer.android.com/reference/android/net/Network.html` to be bound when launching a Custom Tab or using mayLaunchUrl. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_OPEN_IN_BROWSER_STATE() = "androidx.browser.customtabs.extra.OPEN_IN_BROWSER_STATE"` Extra to set the state for the Open in Browser button in the toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_REMOTEVIEWS() = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS"` Extra that specifies the `https://developer.android.com/reference/android/widget/RemoteViews.html` showing on the secondary toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_REMOTEVIEWS_CLICKED_ID() = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_CLICKED_ID"` Extra that specifies which `https://developer.android.com/reference/android/view/View.html` has been clicked. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_REMOTEVIEWS_PENDINGINTENT() = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_PENDINGINTENT"` Extra that specifies the `https://developer.android.com/reference/android/app/PendingIntent.html` to be sent when the user clicks on the `https://developer.android.com/reference/android/view/View.html`s that is listed by `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_REMOTEVIEWS_VIEW_IDS()`. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_REMOTEVIEWS_VIEW_IDS() = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_VIEW_IDS"` Extra that specifies an array of `https://developer.android.com/reference/android/view/View.html` ids. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SECONDARY_TOOLBAR_COLOR() = "android.support.customtabs.extra.SECONDARY_TOOLBAR_COLOR"` Extra that changes the background color for the secondary toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SECONDARY_TOOLBAR_SWIPE_UP_GESTURE() = "androidx.browser.customtabs.extra.SECONDARY_TOOLBAR_SWIPE_UP_GESTURE"` Extra that specifies the `https://developer.android.com/reference/android/app/PendingIntent.html` to be sent when the user swipes up from the secondary (bottom) toolbar. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SEND_TO_EXTERNAL_DEFAULT_HANDLER() = "android.support.customtabs.extra.SEND_TO_EXTERNAL_HANDLER"` Extra to favor sending redirects off of the initial URL to external handler apps, if possible. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SESSION() = "android.support.customtabs.extra.SESSION"` Extra used to match the session. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SHARE_STATE() = "androidx.browser.customtabs.extra.SHARE_STATE"` Extra (int) that specifies which share state should be applied to the custom tab. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TINT_ACTION_BUTTON() = "android.support.customtabs.extra.TINT_ACTION_BUTTON"` Extra boolean that specifies whether the custom action button should be tinted. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TITLE_VISIBILITY_STATE() = "android.support.customtabs.extra.TITLE_VISIBILITY"` Extra (int) that specifies state for showing the page title. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TOOLBAR_COLOR() = "android.support.customtabs.extra.TOOLBAR_COLOR"` Extra that changes the background color for the toolbar. colorRes is an int that specifies a `https://developer.android.com/reference/android/graphics/Color.html`, not a resource id. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TOOLBAR_CORNER_RADIUS_DP() = "androidx.browser.customtabs.extra.TOOLBAR_CORNER_RADIUS_DP"` Extra that sets the toolbar's top corner radii in dp. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TOOLBAR_ITEMS() = "android.support.customtabs.extra.TOOLBAR_ITEMS"` Listused for adding items to the top and bottom toolbars. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TRANSLATE_LANGUAGE_TAG() = "androidx.browser.customtabs.extra.TRANSLATE_LANGUAGE_TAG"` Extra that specifies the target locale the Translate UI should be triggered with. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TRIGGERED_CUSTOM_CONTENT_ACTION_ID() = "androidx.browser.customtabs.extra.TRIGGERED_CUSTOM_CONTENT_ACTION_ID"` Extra added to the `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser when a custom content action is triggered. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#KEY_DESCRIPTION() = "android.support.customtabs.customaction.DESCRIPTION"` Key that specifies the content description for the custom action button. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#KEY_ICON() = "android.support.customtabs.customaction.ICON"` Key that specifies the `https://developer.android.com/reference/android/graphics/Bitmap.html` to be used as the image source for the action button. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#KEY_ID() = "android.support.customtabs.customaction.ID"` Key that specifies the unique ID for an action button. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#KEY_MENU_ITEM_TITLE() = "android.support.customtabs.customaction.MENU_ITEM_TITLE"` Key for specifying the title of a menu item. |
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#KEY_PENDING_INTENT() = "android.support.customtabs.customaction.PENDING_INTENT"` Key that specifies the PendingIntent to launch when the action button or menu item was clicked. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#NO_TITLE() = 0` Don't show any title. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#OPEN_IN_BROWSER_STATE_DEFAULT() = 0` Applies the default Open in Browser button state in the toolbar depending on the browser. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#OPEN_IN_BROWSER_STATE_OFF() = 2` Explicitly does not show the Open in Browser button in the toolbar. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#OPEN_IN_BROWSER_STATE_ON() = 1` Shows the Open in Browser button in the toolbar. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#SHARE_STATE_DEFAULT() = 0` Applies the default share settings depending on the browser. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#SHARE_STATE_OFF() = 2` Explicitly does not show a share option in the tab. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#SHARE_STATE_ON() = 1` Shows a share option in the tab. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#SHOW_PAGE_TITLE() = 1` Shows the page title and the domain. |
| `static final int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#TOOLBAR_ACTION_BUTTON_ID() = 0` The ID allocated to the custom action button that is shown on the toolbar. |
| ### Public fields |
|---|---|
| `final @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#intent()` An `https://developer.android.com/reference/android/content/Intent.html` used to start the Custom Tabs Activity. |
| `final @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#startAnimationBundle()` A `https://developer.android.com/reference/android/os/Bundle.html` containing the start animation for the Custom Tabs Activity. |
| ### Public methods |
|---|---|
| `static int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getActivityResizeBehavior(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the Custom Tab Activity's resize behavior. |
| `static @https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getActivitySideSheetBreakpointDp(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the breakpoint value in dp that will be used to decide if the Custom Tab will be displayed as a bottom sheet or as a side sheet. |
| `static int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getActivitySideSheetDecorationType(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the type of the decoration that will be used to separate the side sheet from the Custom Tabs embedder. |
| `static int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getActivitySideSheetPosition(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the position where the side sheet should be displayed on the screen. |
| `static int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getActivitySideSheetRoundedCornersPosition(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the type of rounded corners that will be used for the side sheet. |
| `static int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getCloseButtonPosition(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the position of the close button. |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/browser/customtabs/CustomTabColorSchemeParams` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getColorSchemeParams(android.content.Intent,int)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent, int colorScheme)` Retrieves the instance of `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabColorSchemeParams` from an Intent for a given color scheme. |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/List.html` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalCustomContentAction https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getCustomContentActions(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Retrieves the list of `https://developer.android.com/reference/androidx/browser/customtabs/CustomContentAction`s configured for the given intent. |
| `static @https://developer.android.com/reference/androidx/annotation/Dimension(unit = 1) int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getInitialActivityHeightPx(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the Custom Tab Activity's initial height. |
| `static @https://developer.android.com/reference/androidx/annotation/Dimension(unit = 1) int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getInitialActivityWidthPx(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the Custom Tab Activity's initial width. |
| `static int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getMaxToolbarItems()()` |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/net/Network.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getNetwork(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the target network that the custom tab is currently bound to if any. |
| `static int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getOpenInBrowserButtonState(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/app/PendingIntent.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getSecondaryToolbarSwipeUpGesture(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` |
| `static @https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) int` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getToolbarCornerRadiusDp(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the toolbar's top corner radii in dp. |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/util/Locale.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#getTranslateLocale(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Gets the target locale for the Translate UI. |
| `static boolean` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#isActivitySideSheetMaximizationEnabled(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Whether the Custom Tab Activity, when acting as a side sheet, can be maximized. |
| `static boolean` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#isBackgroundInteractionEnabled(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` |
| `static boolean` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#isBookmarksButtonEnabled(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` |
| `static boolean` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#isCloseButtonEnabled(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` |
| `static boolean` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#isDownloadButtonEnabled(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` |
| `boolean` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#isEphemeralBrowsingEnabled()()` Returns whether ephemeral browsing is enabled. |
| `static boolean` | `@https://developer.android.com/reference/androidx/browser/customtabs/ExperimentalInitialNavigationCanLeaveBrowser https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#isInitialNavigationAllowedToLeaveBrowser(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` |
| `static boolean` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#isSendToExternalDefaultHandlerEnabled(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` |
| `void` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#launchUrl(android.content.Context,android.net.Uri)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/net/Uri.html url)` Convenience method to launch a Custom Tabs Activity. |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#setAlwaysUseBrowserUI(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/content/Intent.html intent)` Adds the necessary flags and extras to signal any browser supporting custom tabs to use the browser UI at all times and avoid showing custom tab like UI. |
| `static boolean` | `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#shouldAlwaysUseBrowserUI(android.content.Intent)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent)` Whether a browser receiving the given intent should always use browser UI and avoid using any custom tabs UI. |
## Constants
### ACTIVITY_HEIGHT_ADJUSTABLE
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final int ACTIVITY_HEIGHT_ADJUSTABLE = 1
```
The Custom Tab Activity, when it behaves as a bottom sheet, can have its height manually resized by the user.
### ACTIVITY_HEIGHT_DEFAULT
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final int ACTIVITY_HEIGHT_DEFAULT = 0
```
Applies the default height resize behavior for the Custom Tab Activity when it behaves as a bottom sheet.
### ACTIVITY_HEIGHT_FIXED
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final int ACTIVITY_HEIGHT_FIXED = 2
```
The Custom Tab Activity, when it behaves as a bottom sheet, cannot have its height manually resized by the user.
### ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DEFAULT
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DEFAULT = 0
```
Side sheet's default decoration type. Same as `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW()`.
### ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DIVIDER
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DIVIDER = 3
```
Side sheet with a divider line - the activity is bordered by a thin opaque line.
### ACTIVITY_SIDE_SHEET_DECORATION_TYPE_NONE
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_DECORATION_TYPE_NONE = 1
```
Side sheet with no decorations - the activity is not bordered by any shadow or divider line.
### ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW = 2
```
Side sheet with shadow decoration - the activity is bordered by a shadow effect.
### ACTIVITY_SIDE_SHEET_POSITION_DEFAULT
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_POSITION_DEFAULT = 0
```
Applies the default position for the Custom Tab Activity when it behaves as a side sheet. Same as `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_POSITION_END()`.
### ACTIVITY_SIDE_SHEET_POSITION_END
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_POSITION_END = 2
```
Position the side sheet on the end side of the screen.
### ACTIVITY_SIDE_SHEET_POSITION_START
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_POSITION_START = 1
```
Position the side sheet on the start side of the screen.
### ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_DEFAULT
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_DEFAULT = 0
```
Side sheet's default rounded corner configuration. Same as `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE()`
### ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE = 1
```
Side sheet with no rounded corners.
### ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_TOP
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final int ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_TOP = 2
```
Side sheet with the inner top corner rounded (if positioned on the right of the screen, this will be the top left corner)
### CLOSE_BUTTON_POSITION_DEFAULT
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final int CLOSE_BUTTON_POSITION_DEFAULT = 0
```
Same as `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_START()`.
### CLOSE_BUTTON_POSITION_END
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final int CLOSE_BUTTON_POSITION_END = 2
```
Positions the close button at the end of the toolbar.
### CLOSE_BUTTON_POSITION_START
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final int CLOSE_BUTTON_POSITION_START = 1
```
Positions the close button at the start of the toolbar.
### COLOR_SCHEME_DARK
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final int COLOR_SCHEME_DARK = 2
```
Applies a dark color scheme to the user interface in the custom tab. Colors set through `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TOOLBAR_COLOR()` may be darkened to match user expectations.
### COLOR_SCHEME_LIGHT
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final int COLOR_SCHEME_LIGHT = 1
```
Applies a light color scheme to the user interface in the custom tab.
### COLOR_SCHEME_SYSTEM
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final int COLOR_SCHEME_SYSTEM = 0
```
Applies either a light or dark color scheme to the user interface in the custom tab depending on the user's system settings.
### CONTENT_TARGET_TYPE_IMAGE
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final int CONTENT_TARGET_TYPE_IMAGE = 1
```
Content target type: Image. Used with `https://developer.android.com/reference/androidx/browser/customtabs/CustomContentAction.Builder#Builder(int,java.lang.String,android.app.PendingIntent,int)`. An action with this target type may be shown by the browser when the user interacts with an image element on the web page.
### CONTENT_TARGET_TYPE_LINK
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final int CONTENT_TARGET_TYPE_LINK = 2
```
Content target type: Link. Used with `https://developer.android.com/reference/androidx/browser/customtabs/CustomContentAction.Builder#Builder(int,java.lang.String,android.app.PendingIntent,int)`. An action with this target type may be shown by the browser when the user interacts with a link (hyperlink) element on the web page.
### EXTRA_ACTION_BUTTON_BUNDLE
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_ACTION_BUTTON_BUNDLE = "android.support.customtabs.extra.ACTION_BUTTON_BUNDLE"
```
Bundle used for adding a custom action button to the custom tab toolbar. The client should provide a description, an icon `https://developer.android.com/reference/android/graphics/Bitmap.html` and a `https://developer.android.com/reference/android/app/PendingIntent.html` for the button. All three keys must be present.
### EXTRA_ACTIVITY_HEIGHT_RESIZE_BEHAVIOR
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final String EXTRA_ACTIVITY_HEIGHT_RESIZE_BEHAVIOR = "androidx.browser.customtabs.extra.ACTIVITY_HEIGHT_RESIZE_BEHAVIOR"
```
Extra that, if set in combination with `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_HEIGHT_PX()`, defines the height resize behavior of the Custom Tab Activity when it behaves as a bottom sheet. Default is `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_HEIGHT_DEFAULT()`.
### EXTRA_ACTIVITY_SIDE_SHEET_BREAKPOINT_DP
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final String EXTRA_ACTIVITY_SIDE_SHEET_BREAKPOINT_DP = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_BREAKPOINT_DP"
```
Extra that, if set, allows you to set a custom breakpoint for the Custom Tab - a value, x, for which if the screen's width is higher than x, the Custom Tab will behave as a side sheet (if `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_WIDTH_PX()` is set), otherwise it will behave as a bottom sheet (if `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_HEIGHT_PX()` is set). If this Intent Extra is not set the browser implementation should set as default value 840dp. If x is set to \<600dp the browser implementation should default it to 600dp.
### EXTRA_ACTIVITY_SIDE_SHEET_DECORATION_TYPE
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final String EXTRA_ACTIVITY_SIDE_SHEET_DECORATION_TYPE = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_DECORATION_TYPE"
```
Extra that, if set, allows you to set how you want to distinguish the Partial Custom Tab side sheet from the rest of the display. Options include shadow, a divider line, or no decoration.
### EXTRA_ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final String EXTRA_ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION"
```
Extra that enables the maximization button on the side sheet Custom Tab toolbar.
### EXTRA_ACTIVITY_SIDE_SHEET_POSITION
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final String EXTRA_ACTIVITY_SIDE_SHEET_POSITION = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_POSITION"
```
Extra that specifies the position of the side sheet. By default it is set to `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_POSITION_END()`, which is on the right side in left-to-right layout.
### EXTRA_ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final String EXTRA_ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION"
```
Extra that, if set, allows you to choose which side sheet corners should be rounded, if any at all. Options include top or none.
### EXTRA_CLICKED_CONTENT_TARGET_TYPE
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final String EXTRA_CLICKED_CONTENT_TARGET_TYPE = "androidx.browser.customtabs.extra.CLICKED_CONTENT_TARGET_TYPE"
```
Extra added to the `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser when a custom content action is triggered. This extra contains an integer indicating the `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.ContentTargetType` (e.g., `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CONTENT_TARGET_TYPE_IMAGE()` or `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CONTENT_TARGET_TYPE_LINK()`) of the web content element that was interacted with.
### EXTRA_CLOSE_BUTTON_ENABLED
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static final String EXTRA_CLOSE_BUTTON_ENABLED = "androidx.browser.customtabs.extra.CLOSE_BUTTON_ENABLED"
```
Extra that enables the close button and shows it in the toolbar. The close button is enabled by default, this extra provides a way to disable the close button in the toolbar.
### EXTRA_CLOSE_BUTTON_ICON
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_CLOSE_BUTTON_ICON = "android.support.customtabs.extra.CLOSE_BUTTON_ICON"
```
Extra bitmap that specifies the icon of the back button on the toolbar. If the client chooses not to customize it, a default close button will be used.
### EXTRA_CLOSE_BUTTON_POSITION
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final String EXTRA_CLOSE_BUTTON_POSITION = "androidx.browser.customtabs.extra.CLOSE_BUTTON_POSITION"
```
Extra that specifies the position of the close button on the toolbar. Default is `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_DEFAULT()`.
### EXTRA_COLOR_SCHEME
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_COLOR_SCHEME = "androidx.browser.customtabs.extra.COLOR_SCHEME"
```
Extra (int) that specifies which color scheme should be applied to the custom tab. Default is `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#COLOR_SCHEME_SYSTEM()`.
### EXTRA_COLOR_SCHEME_PARAMS
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_COLOR_SCHEME_PARAMS = "androidx.browser.customtabs.extra.COLOR_SCHEME_PARAMS"
```
Extra that contains a SparseArray, mapping color schemes (except `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#COLOR_SCHEME_SYSTEM()`) to `https://developer.android.com/reference/android/os/Bundle.html` representing `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabColorSchemeParams`.
### EXTRA_CONTEXT_IMAGE_ALT_TEXT
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final String EXTRA_CONTEXT_IMAGE_ALT_TEXT = "androidx.browser.customtabs.extra.CONTEXT_IMAGE_ALT_TEXT"
```
Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. If the action was triggered on an image, this extra may contain the alt text of the clicked image, if available.
### EXTRA_CONTEXT_IMAGE_DATA_URI
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final String EXTRA_CONTEXT_IMAGE_DATA_URI = "androidx.browser.customtabs.extra.CONTEXT_IMAGE_DATA_URI"
```
Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. If the action was triggered on an image, this extra may contain the byte data of that image.
### EXTRA_CONTEXT_IMAGE_URL
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final String EXTRA_CONTEXT_IMAGE_URL = "androidx.browser.customtabs.extra.CONTEXT_IMAGE_URL"
```
Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. If the action was triggered on an image, this extra may contain the URL of that image.
### EXTRA_CONTEXT_LINK_TEXT
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final String EXTRA_CONTEXT_LINK_TEXT = "androidx.browser.customtabs.extra.CONTEXT_LINK_TEXT"
```
Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. If the action was triggered on a link, this extra may contain the visible text if available.
### EXTRA_CONTEXT_LINK_URL
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final String EXTRA_CONTEXT_LINK_URL = "androidx.browser.customtabs.extra.CONTEXT_LINK_URL"
```
Extra added to the custom content action `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser. If the action was triggered on an image, this extra may contain the URL of the page displaying that image.
### EXTRA_CUSTOM_CONTENT_ACTIONS
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final String EXTRA_CUSTOM_CONTENT_ACTIONS = "androidx.browser.customtabs.extra.CUSTOM_CONTENT_ACTIONS"
```
Extra for an `https://developer.android.com/reference/java/util/ArrayList.html` of `https://developer.android.com/reference/android/os/Bundle.html` objects, each representing a `https://developer.android.com/reference/androidx/browser/customtabs/CustomContentAction`. The browser reads this to display custom actions. The client application adds this via `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#addCustomContentAction(androidx.browser.customtabs.CustomContentAction)`.
### EXTRA_DEFAULT_SHARE_MENU_ITEM
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0) Deprecated in [1.3.0](https://developer.android.com/jetpack/androidx/releases/browser#1.3.0)
```
public static final String EXTRA_DEFAULT_SHARE_MENU_ITEM = "android.support.customtabs.extra.SHARE_MENU_ITEM"
```
> [!CAUTION]
> **This field is deprecated.**
>
> Use `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SHARE_STATE()` instead.
Boolean extra that specifies whether a default share button will be shown in the menu.
### EXTRA_DISABLE_BACKGROUND_INTERACTION
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static final String EXTRA_DISABLE_BACKGROUND_INTERACTION = "androidx.browser.customtabs.extra.DISABLE_BACKGROUND_INTERACTION"
```
Extra tha disables interactions with the background app when a Partial Custom Tab is launched.
### EXTRA_DISABLE_BOOKMARKS_BUTTON
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static final String EXTRA_DISABLE_BOOKMARKS_BUTTON = "org.chromium.chrome.browser.customtabs.EXTRA_DISABLE_STAR_BUTTON"
```
Extra to disable the bookmarks button in the overflow menu.
### EXTRA_DISABLE_DOWNLOAD_BUTTON
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static final String EXTRA_DISABLE_DOWNLOAD_BUTTON = "org.chromium.chrome.browser.customtabs.EXTRA_DISABLE_DOWNLOAD_BUTTON"
```
Extra to disable the download button in the overflow menu.
### EXTRA_ENABLE_EPHEMERAL_BROWSING
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static final String EXTRA_ENABLE_EPHEMERAL_BROWSING = "androidx.browser.customtabs.extra.ENABLE_EPHEMERAL_BROWSING"
```
Extra that enables ephemeral browsing within the Custom Tab.
### EXTRA_ENABLE_INSTANT_APPS
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_ENABLE_INSTANT_APPS = "android.support.customtabs.extra.EXTRA_ENABLE_INSTANT_APPS"
```
Extra that specifies whether Instant Apps is enabled.
### EXTRA_ENABLE_URLBAR_HIDING
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_ENABLE_URLBAR_HIDING = "android.support.customtabs.extra.ENABLE_URLBAR_HIDING"
```
Boolean extra that enables the url bar to hide as the user scrolls down the page
### EXTRA_EXIT_ANIMATION_BUNDLE
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_EXIT_ANIMATION_BUNDLE = "android.support.customtabs.extra.EXIT_ANIMATION_BUNDLE"
```
Bundle constructed out of `https://developer.android.com/reference/androidx/core/app/ActivityOptionsCompat` that will be running when the `https://developer.android.com/reference/android/app/Activity.html` that holds the custom tab gets finished. A similar ActivityOptions for creation should be constructed and given to the startActivity() call that launches the custom tab.
### EXTRA_INITIAL_ACTIVITY_HEIGHT_PX
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final String EXTRA_INITIAL_ACTIVITY_HEIGHT_PX = "androidx.browser.customtabs.extra.INITIAL_ACTIVITY_HEIGHT_PX"
```
Extra that, if set, makes the Custom Tab Activity's height to be x pixels, the Custom Tab will behave as a bottom sheet. x will be clamped between 50% and 100% of screen height. Bottom sheet does not take effect in landscape mode or in multi-window mode.
### EXTRA_INITIAL_ACTIVITY_WIDTH_PX
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static final String EXTRA_INITIAL_ACTIVITY_WIDTH_PX = "androidx.browser.customtabs.extra.INITIAL_ACTIVITY_WIDTH_PX"
```
Extra that, if set, makes the Custom Tab Activity's width to be x pixels, the Custom Tab will behave as a side sheet. A minimum width will be enforced, thus the width will be clamped as such (based on the window size classes as defined by the Android documentation):
- Compact, window width \<600dp - a side sheet will not be displayed.
- Medium, window width \>=600dp and \<840 dp - between 50% and 100% of the window's width.
- Expanded, window width \>=840dp - between 33% and 100% of the window's width.
[Android Size Classes](https://developer.android.com/guide/topics/large-screens/support-different-screen-sizes#window_size_classes)
### EXTRA_INITIAL_NAVIGATION_CAN_LEAVE_BROWSER
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalInitialNavigationCanLeaveBrowser
public static final String EXTRA_INITIAL_NAVIGATION_CAN_LEAVE_BROWSER = "androidx.browser.customtabs.extra.INITIAL_NAVIGATION_CAN_LEAVE_BROWSER"
```
Extra to favor the Custom Tab forwarding the initial URL sent to the Custom Tab to the default handling app for that URL instead of loading it (including following any redirects) in the Custom Tab.
### EXTRA_MENU_ITEMS
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_MENU_ITEMS = "android.support.customtabs.extra.MENU_ITEMS"
```
Use an `ArrayList` for specifying menu related params. There should be a separate `https://developer.android.com/reference/android/os/Bundle.html` for each custom menu item.
### EXTRA_NAVIGATION_BAR_COLOR
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_NAVIGATION_BAR_COLOR = "androidx.browser.customtabs.extra.NAVIGATION_BAR_COLOR"
```
Extra that contains the color of the navigation bar. See `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#setNavigationBarColor(int)`.
### EXTRA_NAVIGATION_BAR_DIVIDER_COLOR
Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/browser#1.3.0)
```
public static final String EXTRA_NAVIGATION_BAR_DIVIDER_COLOR = "androidx.browser.customtabs.extra.NAVIGATION_BAR_DIVIDER_COLOR"
```
Extra that contains the color of the navigation bar divider. See `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#setNavigationBarDividerColor(int)`.
### EXTRA_NETWORK
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static final String EXTRA_NETWORK = "androidx.browser.customtabs.extra.NETWORK"
```
Extra that specifies the `https://developer.android.com/reference/android/net/Network.html` to be bound when launching a Custom Tab or using mayLaunchUrl. See `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#setNetwork(android.net.Network)`.
### EXTRA_OPEN_IN_BROWSER_STATE
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static final String EXTRA_OPEN_IN_BROWSER_STATE = "androidx.browser.customtabs.extra.OPEN_IN_BROWSER_STATE"
```
Extra to set the state for the Open in Browser button in the toolbar.
### EXTRA_REMOTEVIEWS
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_REMOTEVIEWS = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS"
```
Extra that specifies the `https://developer.android.com/reference/android/widget/RemoteViews.html` showing on the secondary toolbar. If this extra is set, the other secondary toolbar configurations will be overriden. The height of the `https://developer.android.com/reference/android/widget/RemoteViews.html` should not exceed 56dp.
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#setSecondaryToolbarViews(android.widget.RemoteViews,int[],android.app.PendingIntent)` | |
### EXTRA_REMOTEVIEWS_CLICKED_ID
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_REMOTEVIEWS_CLICKED_ID = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_CLICKED_ID"
```
Extra that specifies which `https://developer.android.com/reference/android/view/View.html` has been clicked. This extra will be put to the `https://developer.android.com/reference/android/app/PendingIntent.html` sent from Custom Tabs when a view in the `https://developer.android.com/reference/android/widget/RemoteViews.html` is clicked
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#setSecondaryToolbarViews(android.widget.RemoteViews,int[],android.app.PendingIntent)` | |
### EXTRA_REMOTEVIEWS_PENDINGINTENT
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_REMOTEVIEWS_PENDINGINTENT = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_PENDINGINTENT"
```
Extra that specifies the `https://developer.android.com/reference/android/app/PendingIntent.html` to be sent when the user clicks on the `https://developer.android.com/reference/android/view/View.html`s that is listed by `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_REMOTEVIEWS_VIEW_IDS()`.
Note when this `https://developer.android.com/reference/android/app/PendingIntent.html` is triggered, it will have the current url as data field, also the id of the clicked `https://developer.android.com/reference/android/view/View.html`, specified by `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_REMOTEVIEWS_CLICKED_ID()`.
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#setSecondaryToolbarViews(android.widget.RemoteViews,int[],android.app.PendingIntent)` | |
### EXTRA_REMOTEVIEWS_VIEW_IDS
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_REMOTEVIEWS_VIEW_IDS = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_VIEW_IDS"
```
Extra that specifies an array of `https://developer.android.com/reference/android/view/View.html` ids. When these `https://developer.android.com/reference/android/view/View.html`s are clicked, a `https://developer.android.com/reference/android/app/PendingIntent.html` will be sent, carrying the current url of the custom tab as data.
Note that Custom Tabs will override the default onClick behavior of the listed `https://developer.android.com/reference/android/view/View.html`s. If you do not care about the current url, you can safely ignore this extra and use `https://developer.android.com/reference/android/widget/RemoteViews.html#setOnClickPendingIntent(int, android.app.PendingIntent)` instead.
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#setSecondaryToolbarViews(android.widget.RemoteViews,int[],android.app.PendingIntent)` | |
### EXTRA_SECONDARY_TOOLBAR_COLOR
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_SECONDARY_TOOLBAR_COLOR = "android.support.customtabs.extra.SECONDARY_TOOLBAR_COLOR"
```
Extra that changes the background color for the secondary toolbar. The value should be an int that specifies a `https://developer.android.com/reference/android/graphics/Color.html`, not a resource id.
### EXTRA_SECONDARY_TOOLBAR_SWIPE_UP_GESTURE
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static final String EXTRA_SECONDARY_TOOLBAR_SWIPE_UP_GESTURE = "androidx.browser.customtabs.extra.SECONDARY_TOOLBAR_SWIPE_UP_GESTURE"
```
Extra that specifies the `https://developer.android.com/reference/android/app/PendingIntent.html` to be sent when the user swipes up from the secondary (bottom) toolbar.
### EXTRA_SEND_TO_EXTERNAL_DEFAULT_HANDLER
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static final String EXTRA_SEND_TO_EXTERNAL_DEFAULT_HANDLER = "android.support.customtabs.extra.SEND_TO_EXTERNAL_HANDLER"
```
Extra to favor sending redirects off of the initial URL to external handler apps, if possible. A Custom Tab Intent from a Custom Tab session will always have the package set, so the Intent will always be to the browser. This extra can be used to allow the initial Intent navigation chain to leave the browser.
### EXTRA_SESSION
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_SESSION = "android.support.customtabs.extra.SESSION"
```
Extra used to match the session. This has to be included in the intent to open in a custom tab. This is the same IBinder that gets passed to ICustomTabsService#newSession. Null if there is no need to match any service side sessions with the intent.
### EXTRA_SHARE_STATE
Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/browser#1.3.0)
```
public static final String EXTRA_SHARE_STATE = "androidx.browser.customtabs.extra.SHARE_STATE"
```
Extra (int) that specifies which share state should be applied to the custom tab. Default is `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#SHARE_STATE_DEFAULT()`.
### EXTRA_TINT_ACTION_BUTTON
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_TINT_ACTION_BUTTON = "android.support.customtabs.extra.TINT_ACTION_BUTTON"
```
Extra boolean that specifies whether the custom action button should be tinted. Default is false and the action button will not be tinted.
### EXTRA_TITLE_VISIBILITY_STATE
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_TITLE_VISIBILITY_STATE = "android.support.customtabs.extra.TITLE_VISIBILITY"
```
Extra (int) that specifies state for showing the page title. Default is `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#NO_TITLE()`.
### EXTRA_TOOLBAR_COLOR
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_TOOLBAR_COLOR = "android.support.customtabs.extra.TOOLBAR_COLOR"
```
Extra that changes the background color for the toolbar. colorRes is an int that specifies a `https://developer.android.com/reference/android/graphics/Color.html`, not a resource id.
### EXTRA_TOOLBAR_CORNER_RADIUS_DP
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static final String EXTRA_TOOLBAR_CORNER_RADIUS_DP = "androidx.browser.customtabs.extra.TOOLBAR_CORNER_RADIUS_DP"
```
Extra that sets the toolbar's top corner radii in dp. This will only have effect if the custom tab is behaving as a bottom sheet. Currently, this is capped at 16dp.
### EXTRA_TOOLBAR_ITEMS
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String EXTRA_TOOLBAR_ITEMS = "android.support.customtabs.extra.TOOLBAR_ITEMS"
```
Listused for adding items to the top and bottom toolbars. The client should provide an ID, a description, an icon for each item. They may also provide a if the item is a button.
### EXTRA_TRANSLATE_LANGUAGE_TAG
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static final String EXTRA_TRANSLATE_LANGUAGE_TAG = "androidx.browser.customtabs.extra.TRANSLATE_LANGUAGE_TAG"
```
Extra that specifies the target locale the Translate UI should be triggered with. The locale is represented as a well-formed IETF BCP 47 language tag.
### EXTRA_TRIGGERED_CUSTOM_CONTENT_ACTION_ID
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static final String EXTRA_TRIGGERED_CUSTOM_CONTENT_ACTION_ID = "androidx.browser.customtabs.extra.TRIGGERED_CUSTOM_CONTENT_ACTION_ID"
```
Extra added to the `https://developer.android.com/reference/android/app/PendingIntent.html` by the browser when a custom content action is triggered. This extra contains the integer ID of the specific `https://developer.android.com/reference/androidx/browser/customtabs/CustomContentAction` that was selected by the user. The client application should use this ID to determine which custom action was invoked. The action id cannot be set to negative numbers.
### KEY_DESCRIPTION
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String KEY_DESCRIPTION = "android.support.customtabs.customaction.DESCRIPTION"
```
Key that specifies the content description for the custom action button.
### KEY_ICON
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String KEY_ICON = "android.support.customtabs.customaction.ICON"
```
Key that specifies the `https://developer.android.com/reference/android/graphics/Bitmap.html` to be used as the image source for the action button. The icon should't be more than 24dp in height (No padding needed. The button itself will be 48dp in height) and have a width/height ratio of less than 2.
### KEY_ID
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String KEY_ID = "android.support.customtabs.customaction.ID"
```
Key that specifies the unique ID for an action button. To make a button to show on the toolbar, use `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#TOOLBAR_ACTION_BUTTON_ID()` as its ID.
### KEY_MENU_ITEM_TITLE
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String KEY_MENU_ITEM_TITLE = "android.support.customtabs.customaction.MENU_ITEM_TITLE"
```
Key for specifying the title of a menu item.
### KEY_PENDING_INTENT
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final String KEY_PENDING_INTENT = "android.support.customtabs.customaction.PENDING_INTENT"
```
Key that specifies the PendingIntent to launch when the action button or menu item was clicked. The custom tab will be calling `https://developer.android.com/reference/android/app/PendingIntent.html#send()` on clicks after adding the url as data. The client app can call `https://developer.android.com/reference/android/content/Intent.html#getDataString()` to get the url.
### NO_TITLE
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final int NO_TITLE = 0
```
Don't show any title. Shows only the domain.
### OPEN_IN_BROWSER_STATE_DEFAULT
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static final int OPEN_IN_BROWSER_STATE_DEFAULT = 0
```
Applies the default Open in Browser button state in the toolbar depending on the browser.
### OPEN_IN_BROWSER_STATE_OFF
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static final int OPEN_IN_BROWSER_STATE_OFF = 2
```
Explicitly does not show the Open in Browser button in the toolbar.
### OPEN_IN_BROWSER_STATE_ON
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static final int OPEN_IN_BROWSER_STATE_ON = 1
```
Shows the Open in Browser button in the toolbar.
### SHARE_STATE_DEFAULT
Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/browser#1.3.0)
```
public static final int SHARE_STATE_DEFAULT = 0
```
Applies the default share settings depending on the browser.
### SHARE_STATE_OFF
Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/browser#1.3.0)
```
public static final int SHARE_STATE_OFF = 2
```
Explicitly does not show a share option in the tab.
### SHARE_STATE_ON
Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/browser#1.3.0)
```
public static final int SHARE_STATE_ON = 1
```
Shows a share option in the tab.
### SHOW_PAGE_TITLE
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final int SHOW_PAGE_TITLE = 1
```
Shows the page title and the domain.
### TOOLBAR_ACTION_BUTTON_ID
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static final int TOOLBAR_ACTION_BUTTON_ID = 0
```
The ID allocated to the custom action button that is shown on the toolbar.
## Public fields
### intent
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public final @NonNull Intent intent
```
An `https://developer.android.com/reference/android/content/Intent.html` used to start the Custom Tabs Activity.
### startAnimationBundle
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public final @Nullable Bundle startAnimationBundle
```
A `https://developer.android.com/reference/android/os/Bundle.html` containing the start animation for the Custom Tabs Activity.
## Public methods
### getActivityResizeBehavior
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static int getActivityResizeBehavior(@NonNull Intent intent)
```
Gets the Custom Tab Activity's resize behavior.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the resize behavior from. |
| Returns |
|---|---|
| `int` | The resize behavior. If `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_HEIGHT_PX()` is not set as part of the same intent, the value has no effect. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_HEIGHT_RESIZE_BEHAVIOR()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_HEIGHT_DEFAULT()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_HEIGHT_ADJUSTABLE()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_HEIGHT_FIXED()` | |
### getActivitySideSheetBreakpointDp
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static @Dimension(unit = 0) int getActivitySideSheetBreakpointDp(@NonNull Intent intent)
```
Gets the breakpoint value in dp that will be used to decide if the Custom Tab will be displayed as a bottom sheet or as a side sheet.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the breakpoint value from. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) int` | The breakpoint value or 0 if it is not set. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_BREAKPOINT_DP()` | |
### getActivitySideSheetDecorationType
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static int getActivitySideSheetDecorationType(@NonNull Intent intent)
```
Gets the type of the decoration that will be used to separate the side sheet from the Custom Tabs embedder.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the decoration type from. |
| Returns |
|---|---|
| `int` | The position of the side sheet or the default value if it is not set. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_DECORATION_TYPE()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DEFAULT()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_NONE()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DIVIDER()` | |
### getActivitySideSheetPosition
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static int getActivitySideSheetPosition(@NonNull Intent intent)
```
Gets the position where the side sheet should be displayed on the screen.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the side sheet position from. |
| Returns |
|---|---|
| `int` | The position of the side sheet or the default value if it is not set. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_POSITION()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_POSITION_DEFAULT()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_POSITION_START()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_POSITION_END()` | |
### getActivitySideSheetRoundedCornersPosition
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static int getActivitySideSheetRoundedCornersPosition(@NonNull Intent intent)
```
Gets the type of rounded corners that will be used for the side sheet.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the decoration type from. |
| Returns |
|---|---|
| `int` | The position of the side sheet or the default value if it is not set. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_DECORATION_TYPE()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_DEFAULT()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_TOP()` | |
### getCloseButtonPosition
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static int getCloseButtonPosition(@NonNull Intent intent)
```
Gets the position of the close button.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the position of the close button from. |
| Returns |
|---|---|
| `int` | The position of the close button, or the default position if the extra is not set. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CLOSE_BUTTON_POSITION()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_DEFAULT()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_START()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#CLOSE_BUTTON_POSITION_END()` | |
### getColorSchemeParams
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static @NonNull CustomTabColorSchemeParams getColorSchemeParams(@NonNull Intent intent, int colorScheme)
```
Retrieves the instance of `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabColorSchemeParams` from an Intent for a given color scheme. Uses values passed directly into `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder` (e.g. via `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#setToolbarColor(int)`) as defaults.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the color scheme parameters from. |
| `int colorScheme` | A constant representing a color scheme. Should not be `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#COLOR_SCHEME_SYSTEM()`. |
| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/browser/customtabs/CustomTabColorSchemeParams` | An instance of `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabColorSchemeParams` with retrieved parameters. |
### getCustomContentActions
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalCustomContentAction
public static @NonNull List getCustomContentActions(@NonNull Intent intent)
```
Retrieves the list of `https://developer.android.com/reference/androidx/browser/customtabs/CustomContentAction`s configured for the given intent.
This method is primarily for inspection or debugging by the client application. The browser implementation directly consumes the `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CUSTOM_CONTENT_ACTIONS()` extra.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | The intent from which to retrieve the custom content actions. Must not be null. |
| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/List.html` | A `https://developer.android.com/reference/java/util/List.html` of `https://developer.android.com/reference/androidx/browser/customtabs/CustomContentAction`s. Returns an empty list if no actions were set or if the extra is malformed or missing. The list is unmodifiable. |
### getInitialActivityHeightPx
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static @Dimension(unit = 1) int getInitialActivityHeightPx(@NonNull Intent intent)
```
Gets the Custom Tab Activity's initial height.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the initial Custom Tab Activity's height from. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Dimension(unit = 1) int` | The initial Custom Tab Activity's height or 0 if it is not set. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_HEIGHT_PX()` | |
### getInitialActivityWidthPx
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static @Dimension(unit = 1) int getInitialActivityWidthPx(@NonNull Intent intent)
```
Gets the Custom Tab Activity's initial width.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the initial Custom Tab Activity's width from. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Dimension(unit = 1) int` | The initial Custom Tab Activity's width or 0 if it is not set. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_ACTIVITY_WIDTH_PX()` | |
### getMaxToolbarItems
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static int getMaxToolbarItems()
```
| Returns |
|---|---|
| `int` | The maximum number of allowed toolbar items for `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent.Builder#addToolbarItem(int,android.graphics.Bitmap,java.lang.String,android.app.PendingIntent)` and `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TOOLBAR_ITEMS()`. |
### getNetwork
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static @Nullable Network getNetwork(@NonNull Intent intent)
```
Gets the target network that the custom tab is currently bound to if any.
| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/net/Network.html` | The target `https://developer.android.com/reference/android/net/Network.html` is bound to. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_NETWORK()` | |
### getOpenInBrowserButtonState
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static int getOpenInBrowserButtonState(@NonNull Intent intent)
```
| Returns |
|---|---|
| `int` | The state for the Open in Browser button in the toolbar. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_OPEN_IN_BROWSER_STATE()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#OPEN_IN_BROWSER_STATE_DEFAULT()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#OPEN_IN_BROWSER_STATE_ON()` | |
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#OPEN_IN_BROWSER_STATE_OFF()` | |
### getSecondaryToolbarSwipeUpGesture
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static @Nullable PendingIntent getSecondaryToolbarSwipeUpGesture(@NonNull Intent intent)
```
| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/app/PendingIntent.html` | The `https://developer.android.com/reference/android/app/PendingIntent.html` that will be sent when the user swipes up from the secondary toolbar. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SECONDARY_TOOLBAR_SWIPE_UP_GESTURE()` | |
### getToolbarCornerRadiusDp
Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/browser#1.5.0)
```
public static @Dimension(unit = 0) int getToolbarCornerRadiusDp(@NonNull Intent intent)
```
Gets the toolbar's top corner radii in dp.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | Intent to retrieve the toolbar's top corner radii from. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Dimension(unit = 0) int` | The toolbar's top corner radii in dp. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TOOLBAR_CORNER_RADIUS_DP()` | |
### getTranslateLocale
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static @Nullable Locale getTranslateLocale(@NonNull Intent intent)
```
Gets the target locale for the Translate UI.
| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/util/Locale.html` | The target locale the Translate UI should be triggered with. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_TRANSLATE_LANGUAGE_TAG()` | |
### isActivitySideSheetMaximizationEnabled
Added in [1.8.0](https://developer.android.com/jetpack/androidx/releases/browser#1.8.0)
```
public static boolean isActivitySideSheetMaximizationEnabled(@NonNull Intent intent)
```
Whether the Custom Tab Activity, when acting as a side sheet, can be maximized.
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION()` | |
### isBackgroundInteractionEnabled
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static boolean isBackgroundInteractionEnabled(@NonNull Intent intent)
```
| Returns |
|---|---|
| `boolean` | Whether the background interaction is enabled. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_DISABLE_BACKGROUND_INTERACTION()` | |
### isBookmarksButtonEnabled
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static boolean isBookmarksButtonEnabled(@NonNull Intent intent)
```
| Returns |
|---|---|
| `boolean` | Whether the bookmarks button is enabled. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_DISABLE_BOOKMARKS_BUTTON()` | |
### isCloseButtonEnabled
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public static boolean isCloseButtonEnabled(@NonNull Intent intent)
```
| Returns |
|---|---|
| `boolean` | Whether the close button is enabled. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_CLOSE_BUTTON_ENABLED()` | |
### isDownloadButtonEnabled
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static boolean isDownloadButtonEnabled(@NonNull Intent intent)
```
| Returns |
|---|---|
| `boolean` | Whether the download button is enabled. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_DISABLE_DOWNLOAD_BUTTON()` | |
### isEphemeralBrowsingEnabled
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
public boolean isEphemeralBrowsingEnabled()
```
Returns whether ephemeral browsing is enabled.
### isInitialNavigationAllowedToLeaveBrowser
Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/browser#1.9.0)
```
@ExperimentalInitialNavigationCanLeaveBrowser
public static boolean isInitialNavigationAllowedToLeaveBrowser(@NonNull Intent intent)
```
| Returns |
|---|---|
| `boolean` | Whether the initial URL sent to the custom tab should be sent to the default handling app for that URL. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_INITIAL_NAVIGATION_CAN_LEAVE_BROWSER()` | |
### isSendToExternalDefaultHandlerEnabled
Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/browser#1.7.0)
```
public static boolean isSendToExternalDefaultHandlerEnabled(@NonNull Intent intent)
```
| Returns |
|---|---|
| `boolean` | Whether initial urls are to be sent to external handler apps. |
| See also |
|---|---|
| `https://developer.android.com/reference/androidx/browser/customtabs/CustomTabsIntent#EXTRA_SEND_TO_EXTERNAL_DEFAULT_HANDLER()` | |
### launchUrl
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public void launchUrl(@NonNull Context context, @NonNull Uri url)
```
Convenience method to launch a Custom Tabs Activity.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | The source Context. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/net/Uri.html url` | The URL to load in the Custom Tab. |
### setAlwaysUseBrowserUI
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static @NonNull Intent setAlwaysUseBrowserUI(@Nullable Intent intent)
```
Adds the necessary flags and extras to signal any browser supporting custom tabs to use the browser UI at all times and avoid showing custom tab like UI. Calling this with an intent will override any custom tabs related customizations.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/content/Intent.html intent` | The intent to modify for always showing browser UI. |
| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html` | The same intent with the necessary flags and extras added. |
### shouldAlwaysUseBrowserUI
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)
```
public static boolean shouldAlwaysUseBrowserUI(@NonNull Intent intent)
```
Whether a browser receiving the given intent should always use browser UI and avoid using any custom tabs UI.
| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Intent.html intent` | The intent to check for the required flags and extras. |
| Returns |
|---|---|
| `boolean` | Whether the browser UI should be used exclusively. |