CustomTabsIntent

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.

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.

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.

public static final int ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DEFAULT = 0

Side sheet's default decoration type. Same as ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW.

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.

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.

public static final int ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW = 2

Side sheet with shadow decoration - the activity is bordered by a shadow effect.

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 ACTIVITY_SIDE_SHEET_POSITION_END.

public static final int ACTIVITY_SIDE_SHEET_POSITION_END = 2

Position the side sheet on the end side of the screen.

public static final int ACTIVITY_SIDE_SHEET_POSITION_START = 1

Position the side sheet on the start side of the screen.

public static final int ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_DEFAULT = 0

Side sheet's default rounded corner configuration. Same as ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE

public static final int ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE = 1

Side sheet with no rounded corners.

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)

public static final int CLOSE_BUTTON_POSITION_DEFAULT = 0

Same as CLOSE_BUTTON_POSITION_START.

public static final int CLOSE_BUTTON_POSITION_END = 2

Positions the close button at the end of the toolbar.

public static final int CLOSE_BUTTON_POSITION_START = 1

Positions the close button at the start of the toolbar.

public static final int COLOR_SCHEME_DARK = 2

Applies a dark color scheme to the user interface in the custom tab. Colors set through EXTRA_TOOLBAR_COLOR may be darkened to match user expectations.

public static final int COLOR_SCHEME_LIGHT = 1

Applies a light color scheme to the user interface in the custom tab.

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.

@ExperimentalCustomContentAction
public static final int CONTENT_TARGET_TYPE_IMAGE = 1

Content target type: Image. Used with Builder. An action with this target type may be shown by the browser when the user interacts with an image element on the web page.

@ExperimentalCustomContentAction
public static final int CONTENT_TARGET_TYPE_LINK = 2

Content target type: Link. Used with Builder. 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.

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 Bitmap and a PendingIntent for the button. All three keys must be present.

public static final String EXTRA_ACTIVITY_HEIGHT_RESIZE_BEHAVIOR = "androidx.browser.customtabs.extra.ACTIVITY_HEIGHT_RESIZE_BEHAVIOR"

Extra that, if set in combination with EXTRA_INITIAL_ACTIVITY_HEIGHT_PX, defines the height resize behavior of the Custom Tab Activity when it behaves as a bottom sheet. Default is ACTIVITY_HEIGHT_DEFAULT.

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 EXTRA_INITIAL_ACTIVITY_WIDTH_PX is set), otherwise it will behave as a bottom sheet (if 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.

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.

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.

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 ACTIVITY_SIDE_SHEET_POSITION_END, which is on the right side in left-to-right layout.

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.

@ExperimentalCustomContentAction
public static final String EXTRA_CLICKED_CONTENT_TARGET_TYPE = "androidx.browser.customtabs.extra.CLICKED_CONTENT_TARGET_TYPE"

Extra added to the PendingIntent by the browser when a custom content action is triggered. This extra contains an integer indicating the ContentTargetType (e.g., CONTENT_TARGET_TYPE_IMAGE or CONTENT_TARGET_TYPE_LINK) of the web content element that was interacted with.

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.

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.

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 CLOSE_BUTTON_POSITION_DEFAULT.

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 COLOR_SCHEME_SYSTEM.

public static final String EXTRA_COLOR_SCHEME_PARAMS = "androidx.browser.customtabs.extra.COLOR_SCHEME_PARAMS"

Extra that contains a SparseArray, mapping color schemes (except COLOR_SCHEME_SYSTEM) to Bundle representing CustomTabColorSchemeParams.

@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 PendingIntent by the browser. If the action was triggered on an image, this extra may contain the alt text of the clicked image, if available.

@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 PendingIntent by the browser. If the action was triggered on an image, this extra may contain the byte data of that image.

@ExperimentalCustomContentAction
public static final String EXTRA_CONTEXT_IMAGE_URL = "androidx.browser.customtabs.extra.CONTEXT_IMAGE_URL"

Extra added to the custom content action PendingIntent by the browser. If the action was triggered on an image, this extra may contain the URL of that image.

@ExperimentalCustomContentAction
public static final String EXTRA_CONTEXT_LINK_TEXT = "androidx.browser.customtabs.extra.CONTEXT_LINK_TEXT"

Extra added to the custom content action PendingIntent by the browser. If the action was triggered on a link, this extra may contain the visible text if available.

@ExperimentalCustomContentAction
public static final String EXTRA_CONTEXT_LINK_URL = "androidx.browser.customtabs.extra.CONTEXT_LINK_URL"

Extra added to the custom content action PendingIntent by the browser. If the action was triggered on an image, this extra may contain the URL of the page displaying that image.

@ExperimentalCustomContentAction
public static final String EXTRA_CUSTOM_CONTENT_ACTIONS = "androidx.browser.customtabs.extra.CUSTOM_CONTENT_ACTIONS"

Extra for an ArrayList of Bundle objects, each representing a CustomContentAction. The browser reads this to display custom actions. The client application adds this via addCustomContentAction.

public static final String EXTRA_DEFAULT_SHARE_MENU_ITEM = "android.support.customtabs.extra.SHARE_MENU_ITEM"

Boolean extra that specifies whether a default share button will be shown in the menu.

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.

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.

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.

public static final String EXTRA_ENABLE_EPHEMERAL_BROWSING = "androidx.browser.customtabs.extra.ENABLE_EPHEMERAL_BROWSING"

Extra that enables ephemeral browsing within the Custom Tab.

public static final String EXTRA_ENABLE_INSTANT_APPS = "android.support.customtabs.extra.EXTRA_ENABLE_INSTANT_APPS"

Extra that specifies whether Instant Apps is enabled.

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

public static final String EXTRA_EXIT_ANIMATION_BUNDLE = "android.support.customtabs.extra.EXIT_ANIMATION_BUNDLE"

Bundle constructed out of ActivityOptionsCompat that will be running when the Activity 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.

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.

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.

@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.

public static final String EXTRA_MENU_ITEMS = "android.support.customtabs.extra.MENU_ITEMS"

Use an ArrayList<Bundle> for specifying menu related params. There should be a separate Bundle for each custom menu item.

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 setNavigationBarColor.

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 setNavigationBarDividerColor.

public static final String EXTRA_NETWORK = "androidx.browser.customtabs.extra.NETWORK"

Extra that specifies the Network to be bound when launching a Custom Tab or using mayLaunchUrl. See setNetwork.

@ExperimentalOpenInBrowser
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.

public static final String EXTRA_REMOTEVIEWS = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS"

Extra that specifies the RemoteViews showing on the secondary toolbar. If this extra is set, the other secondary toolbar configurations will be overriden. The height of the RemoteViews should not exceed 56dp.

public static final String EXTRA_REMOTEVIEWS_CLICKED_ID = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_CLICKED_ID"

Extra that specifies which View has been clicked. This extra will be put to the PendingIntent sent from Custom Tabs when a view in the RemoteViews is clicked

public static final String EXTRA_REMOTEVIEWS_PENDINGINTENT = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_PENDINGINTENT"

Extra that specifies the PendingIntent to be sent when the user clicks on the Views that is listed by EXTRA_REMOTEVIEWS_VIEW_IDS.

Note when this PendingIntent is triggered, it will have the current url as data field, also the id of the clicked View, specified by EXTRA_REMOTEVIEWS_CLICKED_ID.

public static final String EXTRA_REMOTEVIEWS_VIEW_IDS = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_VIEW_IDS"

Extra that specifies an array of View ids. When these Views are clicked, a PendingIntent 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 Views. If you do not care about the current url, you can safely ignore this extra and use setOnClickPendingIntent instead.

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 Color, not a resource id.

public static final String EXTRA_SECONDARY_TOOLBAR_SWIPE_UP_GESTURE = "androidx.browser.customtabs.extra.SECONDARY_TOOLBAR_SWIPE_UP_GESTURE"

Extra that specifies the PendingIntent to be sent when the user swipes up from the secondary (bottom) toolbar.

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.

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.

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 SHARE_STATE_DEFAULT.

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.

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 NO_TITLE.

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 Color, not a resource id.

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.

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.

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.

@ExperimentalCustomContentAction
public static final String EXTRA_TRIGGERED_CUSTOM_CONTENT_ACTION_ID = "androidx.browser.customtabs.extra.TRIGGERED_CUSTOM_CONTENT_ACTION_ID"

Extra added to the PendingIntent by the browser when a custom content action is triggered. This extra contains the integer ID of the specific 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.

public static final String KEY_DESCRIPTION = "android.support.customtabs.customaction.DESCRIPTION"

Key that specifies the content description for the custom action button.

public static final String KEY_ICON = "android.support.customtabs.customaction.ICON"

Key that specifies the Bitmap 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.

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 TOOLBAR_ACTION_BUTTON_ID as its ID.

public static final String KEY_MENU_ITEM_TITLE = "android.support.customtabs.customaction.MENU_ITEM_TITLE"

Key for specifying the title of a menu item.

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 send on clicks after adding the url as data. The client app can call getDataString to get the url.

public static final int NO_TITLE = 0

Don't show any title. Shows only the domain.

@ExperimentalOpenInBrowser
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.

@ExperimentalOpenInBrowser
public static final int OPEN_IN_BROWSER_STATE_OFF = 2

Explicitly does not show the Open in Browser button in the toolbar.

@ExperimentalOpenInBrowser
public static final int OPEN_IN_BROWSER_STATE_ON = 1

Shows the Open in Browser button in the toolbar.

public static final int SHARE_STATE_DEFAULT = 0

Applies the default share settings depending on the browser.

public static final int SHARE_STATE_OFF = 2

Explicitly does not show a share option in the tab.

public static final int SHARE_STATE_ON = 1

Shows a share option in the tab.

public static final int SHOW_PAGE_TITLE = 1

Shows the page title and the domain.

public static final int TOOLBAR_ACTION_BUTTON_ID = 0

The ID allocated to the custom action button that is shown on the toolbar.

public final @NonNull Intent intent

An Intent used to start the Custom Tabs Activity.

public final @Nullable Bundle startAnimationBundle

A Bundle containing the start animation for the Custom Tabs Activity.

public static int getActivityResizeBehavior(@NonNull Intent intent)

Gets the Custom Tab Activity's resize behavior.

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.

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.

public static int getActivitySideSheetPosition(@NonNull Intent intent)

Gets the position where the side sheet should be displayed on the screen.

public static int getActivitySideSheetRoundedCornersPosition(@NonNull Intent intent)

Gets the type of rounded corners that will be used for the side sheet.

public static int getCloseButtonPosition(@NonNull Intent intent)

Gets the position of the close button.

public static @NonNull CustomTabColorSchemeParams getColorSchemeParams(@NonNull Intent intent, int colorScheme)

Retrieves the instance of CustomTabColorSchemeParams from an Intent for a given color scheme. Uses values passed directly into CustomTabsIntent.Builder (e.g. via setToolbarColor) as defaults.

@ExperimentalCustomContentAction
public static @NonNull List<CustomContentAction> getCustomContentActions(@NonNull Intent intent)

Retrieves the list of CustomContentActions configured for the given intent.

This method is primarily for inspection or debugging by the client application. The browser implementation directly consumes the EXTRA_CUSTOM_CONTENT_ACTIONS extra.

public static @Dimension(unit = 1) int getInitialActivityHeightPx(@NonNull Intent intent)

Gets the Custom Tab Activity's initial height.

public static @Dimension(unit = 1) int getInitialActivityWidthPx(@NonNull Intent intent)

Gets the Custom Tab Activity's initial width.

public static @Nullable Network getNetwork(@NonNull Intent intent)

Gets the target network that the custom tab is currently bound to if any.

public static @Dimension(unit = 0) int getToolbarCornerRadiusDp(@NonNull Intent intent)

Gets the toolbar's top corner radii in dp.

public static @Nullable Locale getTranslateLocale(@NonNull Intent intent)

Gets the target locale for the Translate UI.

public static boolean isActivitySideSheetMaximizationEnabled(@NonNull Intent intent)

Whether the Custom Tab Activity, when acting as a side sheet, can be maximized.

public boolean isEphemeralBrowsingEnabled()

Returns whether ephemeral browsing is enabled.

public void launchUrl(@NonNull Context context, @NonNull Uri url)

Convenience method to launch a Custom Tabs Activity.

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.

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.