CustomTabsIntent

const val ACTIVITY_HEIGHT_ADJUSTABLE = 1: Int

The Custom Tab Activity, when it behaves as a bottom sheet, can have its height manually resized by the user.

const val ACTIVITY_HEIGHT_DEFAULT = 0: Int

Applies the default height resize behavior for the Custom Tab Activity when it behaves as a bottom sheet.

const val ACTIVITY_HEIGHT_FIXED = 2: Int

The Custom Tab Activity, when it behaves as a bottom sheet, cannot have its height manually resized by the user.

const val ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DEFAULT = 0: Int

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

const val ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DIVIDER = 3: Int

Side sheet with a divider line - the activity is bordered by a thin opaque line.

const val ACTIVITY_SIDE_SHEET_DECORATION_TYPE_NONE = 1: Int

Side sheet with no decorations - the activity is not bordered by any shadow or divider line.

const val ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW = 2: Int

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

const val ACTIVITY_SIDE_SHEET_POSITION_DEFAULT = 0: Int

Applies the default position for the Custom Tab Activity when it behaves as a side sheet. Same as ACTIVITY_SIDE_SHEET_POSITION_END.

const val ACTIVITY_SIDE_SHEET_POSITION_END = 2: Int

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

const val ACTIVITY_SIDE_SHEET_POSITION_START = 1: Int

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

const val ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_DEFAULT = 0: Int

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

const val ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE = 1: Int

Side sheet with no rounded corners.

const val ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_TOP = 2: Int

Side sheet with the inner top corner rounded (if positioned on the right of the screen, this will be the top left corner)

const val CLOSE_BUTTON_POSITION_DEFAULT = 0: Int

Same as CLOSE_BUTTON_POSITION_START.

const val CLOSE_BUTTON_POSITION_END = 2: Int

Positions the close button at the end of the toolbar.

const val CLOSE_BUTTON_POSITION_START = 1: Int

Positions the close button at the start of the toolbar.

const val COLOR_SCHEME_DARK = 2: Int

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.

const val COLOR_SCHEME_LIGHT = 1: Int

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

const val COLOR_SCHEME_SYSTEM = 0: Int

Applies either a light or dark color scheme to the user interface in the custom tab depending on the user's system settings.

const val EXTRA_ACTION_BUTTON_BUNDLE = "android.support.customtabs.extra.ACTION_BUTTON_BUNDLE": String!

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.

const val EXTRA_ACTIVITY_HEIGHT_RESIZE_BEHAVIOR = "androidx.browser.customtabs.extra.ACTIVITY_HEIGHT_RESIZE_BEHAVIOR": String!

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.

const val EXTRA_ACTIVITY_SIDE_SHEET_BREAKPOINT_DP = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_BREAKPOINT_DP": String!

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.

const val EXTRA_ACTIVITY_SIDE_SHEET_DECORATION_TYPE = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_DECORATION_TYPE": String!

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.

const val EXTRA_ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION": String!

Extra that enables the maximization button on the side sheet Custom Tab toolbar.

const val EXTRA_ACTIVITY_SIDE_SHEET_POSITION = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_POSITION": String!

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.

const val EXTRA_ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION = "androidx.browser.customtabs.extra.ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION": String!

Extra that, if set, allows you to choose which side sheet corners should be rounded, if any at all. Options include top or none.

const val EXTRA_CLOSE_BUTTON_ICON = "android.support.customtabs.extra.CLOSE_BUTTON_ICON": String!

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.

const val EXTRA_CLOSE_BUTTON_POSITION = "androidx.browser.customtabs.extra.CLOSE_BUTTON_POSITION": String!

Extra that specifies the position of the close button on the toolbar. Default is CLOSE_BUTTON_POSITION_DEFAULT.

const val EXTRA_COLOR_SCHEME = "androidx.browser.customtabs.extra.COLOR_SCHEME": String!

Extra (int) that specifies which color scheme should be applied to the custom tab. Default is COLOR_SCHEME_SYSTEM.

const val EXTRA_COLOR_SCHEME_PARAMS = "androidx.browser.customtabs.extra.COLOR_SCHEME_PARAMS": String!

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

const val EXTRA_DEFAULT_SHARE_MENU_ITEM = "android.support.customtabs.extra.SHARE_MENU_ITEM": String!

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

const val EXTRA_DISABLE_BACKGROUND_INTERACTION = "androidx.browser.customtabs.extra.DISABLE_BACKGROUND_INTERACTION": String!

Extra tha disables interactions with the background app when a Partial Custom Tab is launched.

const val EXTRA_DISABLE_BOOKMARKS_BUTTON = "org.chromium.chrome.browser.customtabs.EXTRA_DISABLE_STAR_BUTTON": String!

Extra to disable the bookmarks button in the overflow menu.

const val EXTRA_DISABLE_DOWNLOAD_BUTTON = "org.chromium.chrome.browser.customtabs.EXTRA_DISABLE_DOWNLOAD_BUTTON": String!

Extra to disable the download button in the overflow menu.

const val EXTRA_ENABLE_INSTANT_APPS = "android.support.customtabs.extra.EXTRA_ENABLE_INSTANT_APPS": String!

Extra that specifies whether Instant Apps is enabled.

const val EXTRA_ENABLE_URLBAR_HIDING = "android.support.customtabs.extra.ENABLE_URLBAR_HIDING": String!

Boolean extra that enables the url bar to hide as the user scrolls down the page

const val EXTRA_EXIT_ANIMATION_BUNDLE = "android.support.customtabs.extra.EXIT_ANIMATION_BUNDLE": String!

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.

const val EXTRA_INITIAL_ACTIVITY_HEIGHT_PX = "androidx.browser.customtabs.extra.INITIAL_ACTIVITY_HEIGHT_PX": String!

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.

const val EXTRA_INITIAL_ACTIVITY_WIDTH_PX = "androidx.browser.customtabs.extra.INITIAL_ACTIVITY_WIDTH_PX": String!

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.

const val EXTRA_MENU_ITEMS = "android.support.customtabs.extra.MENU_ITEMS": String!

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

const val EXTRA_NAVIGATION_BAR_COLOR = "androidx.browser.customtabs.extra.NAVIGATION_BAR_COLOR": String!

Extra that contains the color of the navigation bar. See setNavigationBarColor.

const val EXTRA_NAVIGATION_BAR_DIVIDER_COLOR = "androidx.browser.customtabs.extra.NAVIGATION_BAR_DIVIDER_COLOR": String!

Extra that contains the color of the navigation bar divider. See setNavigationBarDividerColor.

const val EXTRA_REMOTEVIEWS = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS": String!

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.

const val EXTRA_REMOTEVIEWS_CLICKED_ID = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_CLICKED_ID": String!

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

const val EXTRA_REMOTEVIEWS_PENDINGINTENT = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_PENDINGINTENT": String!

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.

const val EXTRA_REMOTEVIEWS_VIEW_IDS = "android.support.customtabs.extra.EXTRA_REMOTEVIEWS_VIEW_IDS": String!

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.

const val EXTRA_SECONDARY_TOOLBAR_COLOR = "android.support.customtabs.extra.SECONDARY_TOOLBAR_COLOR": String!

Extra that changes the background color for the secondary toolbar. The value should be an int that specifies a Color, not a resource id.

const val EXTRA_SECONDARY_TOOLBAR_SWIPE_UP_GESTURE = "androidx.browser.customtabs.extra.SECONDARY_TOOLBAR_SWIPE_UP_GESTURE": String!

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

const val EXTRA_SEND_TO_EXTERNAL_DEFAULT_HANDLER = "android.support.customtabs.extra.SEND_TO_EXTERNAL_HANDLER": String!

Extra to favor sending initial urls 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.

const val EXTRA_SESSION = "android.support.customtabs.extra.SESSION": String!

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.

const val EXTRA_SHARE_STATE = "androidx.browser.customtabs.extra.SHARE_STATE": String!

Extra (int) that specifies which share state should be applied to the custom tab. Default is SHARE_STATE_DEFAULT.

const val EXTRA_TINT_ACTION_BUTTON = "android.support.customtabs.extra.TINT_ACTION_BUTTON": String!

Extra boolean that specifies whether the custom action button should be tinted. Default is false and the action button will not be tinted.

const val EXTRA_TITLE_VISIBILITY_STATE = "android.support.customtabs.extra.TITLE_VISIBILITY": String!

Extra (int) that specifies state for showing the page title. Default is NO_TITLE.

const val EXTRA_TOOLBAR_COLOR = "android.support.customtabs.extra.TOOLBAR_COLOR": String!

Extra that changes the background color for the toolbar. colorRes is an int that specifies a Color, not a resource id.

const val EXTRA_TOOLBAR_CORNER_RADIUS_DP = "androidx.browser.customtabs.extra.TOOLBAR_CORNER_RADIUS_DP": String!

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.

const val EXTRA_TOOLBAR_ITEMS = "android.support.customtabs.extra.TOOLBAR_ITEMS": String!

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.

const val EXTRA_TRANSLATE_LANGUAGE_TAG = "androidx.browser.customtabs.extra.TRANSLATE_LANGUAGE_TAG": String!

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.

const val KEY_DESCRIPTION = "android.support.customtabs.customaction.DESCRIPTION": String!

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

const val KEY_ICON = "android.support.customtabs.customaction.ICON": String!

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.

const val KEY_ID = "android.support.customtabs.customaction.ID": String!

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.

const val KEY_MENU_ITEM_TITLE = "android.support.customtabs.customaction.MENU_ITEM_TITLE": String!

Key for specifying the title of a menu item.

const val KEY_PENDING_INTENT = "android.support.customtabs.customaction.PENDING_INTENT": String!

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.

const val NO_TITLE = 0: Int

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

const val SHARE_STATE_DEFAULT = 0: Int

Applies the default share settings depending on the browser.

const val SHARE_STATE_OFF = 2: Int

Explicitly does not show a share option in the tab.

const val SHARE_STATE_ON = 1: Int

Shows a share option in the tab.

const val SHOW_PAGE_TITLE = 1: Int

Shows the page title and the domain.

const val TOOLBAR_ACTION_BUTTON_ID = 0: Int

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

java-static fun getActivityResizeBehavior(intent: Intent): Int

Gets the Custom Tab Activity's resize behavior.

java-static fun getActivitySideSheetBreakpointDp(intent: Intent): @Dimension(unit = 0) Int

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.

java-static fun getActivitySideSheetDecorationType(intent: Intent): Int

Gets the type of the decoration that will be used to separate the side sheet from the Custom Tabs embedder.

java-static fun getActivitySideSheetPosition(intent: Intent): Int

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

java-static fun getActivitySideSheetRoundedCornersPosition(intent: Intent): Int

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

java-static fun getCloseButtonPosition(intent: Intent): Int

Gets the position of the close button.

java-static fun getColorSchemeParams(intent: Intent, colorScheme: Int): CustomTabColorSchemeParams

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.

java-static fun getInitialActivityHeightPx(intent: Intent): @Dimension(unit = 1) Int

Gets the Custom Tab Activity's initial height.

java-static fun getInitialActivityWidthPx(intent: Intent): @Dimension(unit = 1) Int

Gets the Custom Tab Activity's initial width.

java-static fun getMaxToolbarItems(): Int

java-static fun getSecondaryToolbarSwipeUpGesture(intent: Intent): PendingIntent?

java-static fun getToolbarCornerRadiusDp(intent: Intent): @Dimension(unit = 0) Int

Gets the toolbar's top corner radii in dp.

java-static fun getTranslateLocale(intent: Intent): Locale?

Gets the target locale for the Translate UI.

java-static fun isActivitySideSheetMaximizationEnabled(intent: Intent): Boolean

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

java-static fun isBackgroundInteractionEnabled(intent: Intent): Boolean

java-static fun isBookmarksButtonEnabled(intent: Intent): Boolean

java-static fun isDownloadButtonEnabled(intent: Intent): Boolean

java-static fun isSendToExternalDefaultHandlerEnabled(intent: Intent): Boolean

fun launchUrl(context: Context, url: Uri): Unit

Convenience method to launch a Custom Tabs Activity.

java-static fun setAlwaysUseBrowserUI(intent: 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.

java-static fun shouldAlwaysUseBrowserUI(intent: Intent): Boolean

Whether a browser receiving the given intent should always use browser UI and avoid using any custom tabs UI.

val intent: Intent

An Intent used to start the Custom Tabs Activity.

val startAnimationBundle: Bundle?

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