Overview

Builder class for CustomTabsIntent objects.

Summary

Constructors

Creates a CustomTabsIntent.Builder object associated with no CustomTabsSession.

Creates a CustomTabsIntent.Builder object associated with a given CustomTabsSession. Guarantees that the will be sent to the same component as the one the session is associated with.

Parameters:

session: The session to associate this Builder with.

Methods

Associates the with the given CustomTabsSession. Guarantees that the will be sent to the same component as the one the session is associated with.

Associates the with the given CustomTabsSession.PendingSession. Overrides the effect of CustomTabsIntent.Builder.setSession(CustomTabsSession).

Deprecated: Use CustomTabsIntent.Builder.setDefaultColorSchemeParams(CustomTabColorSchemeParams) instead.

Sets the toolbar color. On Android L and above, this color is also applied to the status bar. To ensure good contrast between status bar icons and the background, Custom Tab implementations may use View on Android M and above, and use a darkened color for the status bar on Android L. Can be overridden for particular color schemes, see CustomTabsIntent.Builder.setColorSchemeParams(int, CustomTabColorSchemeParams).

Parameters:

color:

Deprecated: Use CustomTabsIntent.Builder.setUrlBarHidingEnabled(boolean) instead.

Enables the url bar to hide as the user scrolls down on the page.

Set whether the url bar should hide as the user scrolls down on the page.

Parameters:

enabled: Whether url bar hiding is enabled.

Sets the Close button icon for the custom tab.

Parameters:

icon: The icon Bitmap

Sets whether the title should be shown in the custom tab.

Parameters:

showTitle: Whether the title should be shown.

Adds a menu item.

Parameters:

label: Menu label.
pendingIntent: Pending intent delivered when the menu item is clicked.

Deprecated: Use CustomTabsIntent.Builder.setShareState(int) instead. This will set the share state to CustomTabsIntent.SHARE_STATE_ON.

Adds a default share item to the menu.

Deprecated: Use CustomTabsIntent.Builder.setShareState(int) instead. This will set the share state to CustomTabsIntent.SHARE_STATE_ON or CustomTabsIntent.SHARE_STATE_OFF based on enabled.

Set whether a default share item is added to the menu.

Parameters:

enabled: Whether default share item is added.

Sets the share state that should be applied to the custom tab.

Parameters:

shareState: Desired share state.

See also: CustomTabsIntent.SHARE_STATE_DEFAULT, CustomTabsIntent.SHARE_STATE_ON, CustomTabsIntent.SHARE_STATE_OFF

Sets the action button that is displayed in the Toolbar.

This is equivalent to calling CustomTabsIntent.Builder.addToolbarItem(int, Bitmap, String, PendingIntent) with CustomTabsIntent.TOOLBAR_ACTION_BUTTON_ID as id.

Parameters:

icon: The icon.
description: The description for the button. To be used for accessibility.
pendingIntent: pending intent delivered when the button is clicked.
shouldTint: Whether the action button should be tinted..

See also: CustomTabsIntent.Builder.addToolbarItem(int, Bitmap, String, PendingIntent)

Sets the action button that is displayed in the Toolbar with default tinting behavior.

See also: CustomTabsIntent.Builder.setActionButton(Bitmap, String, PendingIntent, boolean)

Deprecated: Use CustomTabsIntent.Builder#setSecondaryToolbarViews(RemoteViews, int[], PendingIntent).

Adds an action button to the custom tab. Multiple buttons can be added via this method. If the given id equals CustomTabsIntent.TOOLBAR_ACTION_BUTTON_ID, the button will be placed on the toolbar; if the bitmap is too wide, it will be put to the bottom bar instead. If the id is not CustomTabsIntent.TOOLBAR_ACTION_BUTTON_ID, it will be directly put on secondary toolbar. The maximum number of allowed toolbar items in a single intent is CustomTabsIntent.getMaxToolbarItems(). Throws an java.lang.IllegalStateException when that number is exceeded per intent.

Parameters:

id: The unique id of the action button. This should be non-negative.
icon: The icon.
description: The description for the button. To be used for accessibility.
pendingIntent: The pending intent delivered when the button is clicked.

See also: CustomTabsIntent.getMaxToolbarItems()

Deprecated: Use CustomTabsIntent.Builder.setDefaultColorSchemeParams(CustomTabColorSchemeParams) instead.

Sets the color of the secondary toolbar. Can be overridden for particular color schemes, see CustomTabsIntent.Builder.setColorSchemeParams(int, CustomTabColorSchemeParams).

Parameters:

color: The color for the secondary toolbar.

Deprecated: Use CustomTabsIntent.Builder.setDefaultColorSchemeParams(CustomTabColorSchemeParams) instead.

Sets the navigation bar color. Has no effect on API versions below L. To ensure good contrast between navigation bar icons and the background, Custom Tab implementations may use View on Android O and above, and darken the provided color on Android L-N. Can be overridden for particular color schemes, see CustomTabsIntent.Builder.setColorSchemeParams(int, CustomTabColorSchemeParams).

Parameters:

color: The color for the navigation bar.

Deprecated: Use CustomTabsIntent.Builder.setDefaultColorSchemeParams(CustomTabColorSchemeParams) instead.

Sets the navigation bar divider color. Has no effect on API versions below P. Can be overridden for particular color schemes, see CustomTabsIntent.Builder.setColorSchemeParams(int, CustomTabColorSchemeParams).

Parameters:

color: The color for the navigation bar divider.

Sets the remote views displayed in the secondary toolbar in a custom tab.

Parameters:

remoteViews: The that will be shown on the secondary toolbar.
clickableIDs: The IDs of clickable views. The onClick event of these views will be handled by custom tabs.
pendingIntent: The PendingIntent that will be sent when the user clicks on one of the Views in clickableIDs. When the PendingIntent is sent, it will have the current URL as its intent data.

See also: CustomTabsIntent.EXTRA_REMOTEVIEWS, CustomTabsIntent.EXTRA_REMOTEVIEWS_VIEW_IDS, CustomTabsIntent.EXTRA_REMOTEVIEWS_PENDINGINTENT, CustomTabsIntent.EXTRA_REMOTEVIEWS_CLICKED_ID

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

Parameters:

pendingIntent: The PendingIntent that will be sent when the user swipes up from the secondary toolbar.

Sets whether Instant Apps is enabled for this Custom Tab.

Parameters:

enabled: Whether Instant Apps should be enabled.

Sets the start animations.

Parameters:

context: Application context.
enterResId: Resource ID of the "enter" animation for the browser.
exitResId: Resource ID of the "exit" animation for the application.

Sets the exit animations.

Parameters:

context: Application context.
enterResId: Resource ID of the "enter" animation for the application.
exitResId: Resource ID of the "exit" animation for the browser.

Sets the color scheme that should be applied to the user interface in the custom tab.

Parameters:

colorScheme: Desired color scheme.

See also: CustomTabsIntent.COLOR_SCHEME_SYSTEM, CustomTabsIntent.COLOR_SCHEME_LIGHT, CustomTabsIntent.COLOR_SCHEME_DARK

Sets CustomTabColorSchemeParams for the given color scheme. This allows specifying two different toolbar colors for light and dark schemes. It can be useful if CustomTabsIntent.COLOR_SCHEME_SYSTEM is set: Custom Tabs will follow the system settings and apply the corresponding CustomTabColorSchemeParams "on the fly" when the settings change. If there is no CustomTabColorSchemeParams for the current scheme, or a particular field of it is null, Custom Tabs will fall back to the defaults provided via CustomTabsIntent.Builder.setDefaultColorSchemeParams(CustomTabColorSchemeParams). Example:

     CustomTabColorSchemeParams darkParams = new CustomTabColorSchemeParams.Builder()
             .setToolbarColor(darkColor)
             .build();
     CustomTabColorSchemeParams otherParams = new CustomTabColorSchemeParams.Builder()
             .setNavigationBarColor(otherColor)
             .build();
     CustomTabIntent intent = new CustomTabIntent.Builder()
             .setColorScheme(COLOR_SCHEME_SYSTEM)
             .setColorSchemeParams(COLOR_SCHEME_DARK, darkParams)
             .setDefaultColorSchemeParams(otherParams)
             .build();
 

Parameters:

colorScheme: A constant representing a color scheme (see CustomTabsIntent.Builder.setColorScheme(int)). It should not be CustomTabsIntent.COLOR_SCHEME_SYSTEM, because that represents a behavior rather than a particular color scheme.
params: An instance of CustomTabColorSchemeParams.

Sets the default CustomTabColorSchemeParams. This will set a default color scheme that applies when no CustomTabColorSchemeParams specified for current color scheme via CustomTabsIntent.Builder.setColorSchemeParams(int, CustomTabColorSchemeParams).

Parameters:

params: An instance of CustomTabColorSchemeParams.

Sets the Custom Tab Activity's initial height in pixels and the desired resize behavior. The Custom Tab will behave as a bottom sheet if the screen's width is smaller than the breakpoint value set by CustomTabsIntent.Builder.setActivitySideSheetBreakpointDp(int).

Parameters:

initialHeightPx: The Custom Tab Activity's initial height in pixels.
activityHeightResizeBehavior: Desired height behavior.

See also: CustomTabsIntent.EXTRA_INITIAL_ACTIVITY_HEIGHT_PX, CustomTabsIntent.EXTRA_ACTIVITY_HEIGHT_RESIZE_BEHAVIOR, CustomTabsIntent.ACTIVITY_HEIGHT_DEFAULT, CustomTabsIntent.ACTIVITY_HEIGHT_ADJUSTABLE, CustomTabsIntent.ACTIVITY_HEIGHT_FIXED

Sets the Custom Tab Activity's initial height in pixels with default resize behavior. The Custom Tab will behave as a bottom sheet if the screen's width is smaller than the breakpoint value set by CustomTabsIntent.Builder.setActivitySideSheetBreakpointDp(int).

See also: CustomTabsIntent.Builder.setInitialActivityHeightPx(int, int)

Sets the Custom Tab Activity's initial width in pixels. The Custom Tab will behave as a side sheet if the screen's width is bigger than the breakpoint value set by CustomTabsIntent.Builder.setActivitySideSheetBreakpointDp(int) and the screen is big enough, see doc for CustomTabsIntent.EXTRA_INITIAL_ACTIVITY_WIDTH_PX.

Parameters:

initialWidthPx: The Custom Tab Activity's initial width in pixels.

See also: CustomTabsIntent.EXTRA_INITIAL_ACTIVITY_WIDTH_PX

Sets the Custom Tab Activity's transition breakpoint in DP.

Parameters:

breakpointDp: The Custom Tab Activity's breakpoint in DP.

See also: CustomTabsIntent.EXTRA_ACTIVITY_SIDE_SHEET_BREAKPOINT_DP

Enables or disables the maximization button for when the Custom Tab Activity is acting as a side sheet. The button is disabled by default.

Parameters:

enabled: Whether the maximization button is enabled.

See also: CustomTabsIntent.EXTRA_ACTIVITY_SIDE_SHEET_ENABLE_MAXIMIZATION

Sets the Custom Tab Activity's position when acting as a side sheet.

Parameters:

position: The Custom Tab Activity's position.

See also: CustomTabsIntent.EXTRA_ACTIVITY_SIDE_SHEET_POSITION, CustomTabsIntent.CLOSE_BUTTON_POSITION_DEFAULT, CustomTabsIntent.CLOSE_BUTTON_POSITION_START, CustomTabsIntent.CLOSE_BUTTON_POSITION_END

Sets the Custom Tab Activity's decoration type that will be displayed when it is acting as a side sheet.

Parameters:

decorationType: The Custom Tab Activity's decoration type.

See also: CustomTabsIntent.EXTRA_ACTIVITY_SIDE_SHEET_DECORATION_TYPE, CustomTabsIntent.ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DEFAULT, CustomTabsIntent.ACTIVITY_SIDE_SHEET_DECORATION_TYPE_NONE, CustomTabsIntent.ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW, CustomTabsIntent.ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DIVIDER

Sets the Custom Tab Activity's rounded corners position when it is acting as a side sheet.

Parameters:

roundedCornersPosition: The Custom Tab Activity's rounded corners position.

See also: CustomTabsIntent.EXTRA_ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION, CustomTabsIntent.ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_DEFAULT, CustomTabsIntent.ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_NONE, CustomTabsIntent.ACTIVITY_SIDE_SHEET_ROUNDED_CORNERS_POSITION_TOP

Sets the toolbar's top corner radii in dp.

Parameters:

cornerRadiusDp: The toolbar's top corner radii in dp.

See also: CustomTabsIntent.EXTRA_TOOLBAR_CORNER_RADIUS_DP

Sets the position of the close button.

Parameters:

position: The desired position.

See also: CustomTabsIntent.CLOSE_BUTTON_POSITION_DEFAULT, CustomTabsIntent.CLOSE_BUTTON_POSITION_START, CustomTabsIntent.CLOSE_BUTTON_POSITION_END

Enables or disables the bookmarks button in the overflow menu. The button is enabled by default.

Parameters:

enabled: Whether the start button is enabled.

See also: CustomTabsIntent.EXTRA_DISABLE_BOOKMARKS_BUTTON

Enables or disables the download button in the overflow menu. The button is enabled by default.

Parameters:

enabled: Whether the download button is enabled.

See also: CustomTabsIntent.EXTRA_DISABLE_DOWNLOAD_BUTTON

Enables sending initial urls to external handler apps, if possible.

Parameters:

enabled: Whether to send urls to external handler.

See also: CustomTabsIntent.EXTRA_SEND_TO_EXTERNAL_DEFAULT_HANDLER

Specifies the target locale the Translate UI should be triggered with.

Parameters:

locale: java.util.Locale object that represents the target locale.

See also: CustomTabsIntent.EXTRA_TRANSLATE_LANGUAGE_TAG

Enables the capability of the interaction with background. Enables the interactions with the background app when a Partial Custom Tab is launched.

Parameters:

enabled: Whether the background interaction is enabled.

See also: CustomTabsIntent.EXTRA_DISABLE_BACKGROUND_INTERACTION

Allow Custom Tabs to obtain the caller's identity i.e. package name.

Parameters:

enabled: Whether the identity sharing is enabled.

Combines all the options that have been set and returns a new CustomTabsIntent object.