CustomTabsIntent.Builder

public final class CustomTabsIntent.Builder

Builder class for CustomTabsIntent objects.

Summary

Public constructors

Creates a CustomTabsIntent.Builder object associated with no CustomTabsSession.

Creates a CustomTabsIntent.Builder object associated with a given CustomTabsSession.

Public methods
@NonNull CustomTabsIntent.Builder

Adds a custom content action that can be invoked by the user on specific content types (image or link) within the Custom Tab.
@NonNull CustomTabsIntent.Builder

This method is deprecated.

Use setShareState instead.
@NonNull CustomTabsIntent.Builder
addMenuItem(@NonNull String label, @NonNull PendingIntent pendingIntent)

Adds a menu item.
@NonNull CustomTabsIntent.Builder
addToolbarItem(
    int id,
    @NonNull Bitmap icon,
    @NonNull String description,
    @NonNull PendingIntent pendingIntent
)

This method is deprecated.

Use CustomTabsIntent.Builder#setSecondaryToolbarViews(RemoteViews, int[], PendingIntent).
@NonNull CustomTabsIntent

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

This method is deprecated.

Use setUrlBarHidingEnabled instead.
@NonNull CustomTabsIntent.Builder
setActionButton(
    @NonNull Bitmap icon,
    @NonNull String description,
    @NonNull PendingIntent pendingIntent
)

Sets the action button that is displayed in the Toolbar with default tinting behavior.
@NonNull CustomTabsIntent.Builder
setActionButton(
    @NonNull Bitmap icon,
    @NonNull String description,
    @NonNull PendingIntent pendingIntent,
    boolean shouldTint
)

Sets the action button that is displayed in the Toolbar.
@NonNull CustomTabsIntent.Builder
setActivitySideSheetBreakpointDp(@Dimension(unit = 0) int breakpointDp)

Sets the Custom Tab Activity's transition breakpoint in DP.
@NonNull CustomTabsIntent.Builder

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

Enables or disables the maximization button for when the Custom Tab Activity is acting as a side sheet.
@NonNull CustomTabsIntent.Builder

Sets the Custom Tab Activity's position when acting as a side sheet.
@NonNull CustomTabsIntent.Builder
setActivitySideSheetRoundedCornersPosition(int roundedCornersPosition)

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

Enables the capability of the interaction with background.
@NonNull CustomTabsIntent.Builder
setBookmarksButtonEnabled(boolean enabled)

Enables or disables the bookmarks button in the overflow menu.
@NonNull CustomTabsIntent.Builder
setCloseButtonEnabled(boolean enabled)

Sets whether to enable the close button for custom tab.
@NonNull CustomTabsIntent.Builder

Sets the Close button icon for the custom tab.
@NonNull CustomTabsIntent.Builder
setCloseButtonPosition(int position)

Sets the position of the close button.
@NonNull CustomTabsIntent.Builder
setColorScheme(int colorScheme)

Sets the color scheme that should be applied to the user interface in the custom tab.
@NonNull CustomTabsIntent.Builder
setColorSchemeParams(
    int colorScheme,
    @NonNull CustomTabColorSchemeParams params
)

Sets CustomTabColorSchemeParams for the given color scheme.
@NonNull CustomTabsIntent.Builder

Sets the default CustomTabColorSchemeParams.
@NonNull CustomTabsIntent.Builder

This method is deprecated.

Use setShareState instead.
@NonNull CustomTabsIntent.Builder
setDownloadButtonEnabled(boolean enabled)

Enables or disables the download button in the overflow menu.
@NonNull CustomTabsIntent.Builder
setEphemeralBrowsingEnabled(boolean enabled)

Sets whether to enable ephemeral browsing within the Custom Tab.
@NonNull CustomTabsIntent.Builder
setExitAnimations(
    @NonNull Context context,
    @AnimRes int enterResId,
    @AnimRes int exitResId
)

Sets the exit animations.
@NonNull CustomTabsIntent.Builder
setInitialActivityHeightPx(@Dimension(unit = 1) int initialHeightPx)

Sets the Custom Tab Activity's initial height in pixels with default resize behavior.
@NonNull CustomTabsIntent.Builder
setInitialActivityHeightPx(
    @Dimension(unit = 1) int initialHeightPx,
    int activityHeightResizeBehavior
)

Sets the Custom Tab Activity's initial height in pixels and the desired resize behavior.
@NonNull CustomTabsIntent.Builder
setInitialActivityWidthPx(@Dimension(unit = 1) int initialWidthPx)

Sets the Custom Tab Activity's initial width in pixels.
@NonNull CustomTabsIntent.Builder
setInstantAppsEnabled(boolean enabled)

Sets whether Instant Apps is enabled for this Custom Tab.
@NonNull CustomTabsIntent.Builder

This method is deprecated.

Use setDefaultColorSchemeParams instead.
@NonNull CustomTabsIntent.Builder

This method is deprecated.

Use setDefaultColorSchemeParams instead.
@NonNull CustomTabsIntent.Builder

Sets the target network Network to bind when launching a custom tab.
@NonNull CustomTabsIntent.Builder

Sets the state for the Open in Browser button in the toolbar for this Custom Tab.
@NonNull CustomTabsIntent.Builder

Associates the Intent with the given CustomTabsSession.PendingSession.
@NonNull CustomTabsIntent.Builder

This method is deprecated.

Use setDefaultColorSchemeParams instead.
@NonNull CustomTabsIntent.Builder

Sets the PendingIntent to be sent when the user swipes up from the secondary (bottom) toolbar.
@NonNull CustomTabsIntent.Builder
setSecondaryToolbarViews(
    @NonNull RemoteViews remoteViews,
    @Nullable int[] clickableIDs,
    @Nullable PendingIntent pendingIntent
)

Sets the remote views displayed in the secondary toolbar in a custom tab.
@NonNull CustomTabsIntent.Builder

Enables sending initial urls to external handler apps, if possible.
@NonNull CustomTabsIntent.Builder

Associates the Intent with the given CustomTabsSession.
@NonNull CustomTabsIntent.Builder
setShareIdentityEnabled(boolean enabled)

Allow Custom Tabs to obtain the caller's identity i.e. package name.
@NonNull CustomTabsIntent.Builder
setShareState(int shareState)

Sets the share state that should be applied to the custom tab.
@NonNull CustomTabsIntent.Builder
setShowTitle(boolean showTitle)

Sets whether the title should be shown in the custom tab.
@NonNull CustomTabsIntent.Builder
setStartAnimations(
    @NonNull Context context,
    @AnimRes int enterResId,
    @AnimRes int exitResId
)

Sets the start animations.
@NonNull CustomTabsIntent.Builder

This method is deprecated.

Use setDefaultColorSchemeParams instead.
@NonNull CustomTabsIntent.Builder
setToolbarCornerRadiusDp(@Dimension(unit = 0) int cornerRadiusDp)

Sets the toolbar's top corner radii in dp.
@NonNull CustomTabsIntent.Builder

Specifies the target locale the Translate UI should be triggered with.
@NonNull CustomTabsIntent.Builder
setUrlBarHidingEnabled(boolean enabled)

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

Public constructors

Builder

Added in 1.2.0
public Builder()

Creates a CustomTabsIntent.Builder object associated with no CustomTabsSession.

Builder

Added in 1.2.0
public Builder(@Nullable CustomTabsSession session)

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

Parameters
@Nullable CustomTabsSession session

The session to associate this Builder with.

Public methods

addCustomContentAction

Added in 1.9.0-rc01
@ExperimentalCustomContentAction
public @NonNull CustomTabsIntent.Builder addCustomContentAction(@NonNull CustomContentAction action)

Adds a custom content action that can be invoked by the user on specific content types (image or link) within the Custom Tab.

The number of actions shown to the user is at the browser's discretion. The browser may choose not to display all the actions provided. Additionally, priority will be based on the order the actions were added, with the earliest added action being given the highest priority.

When the user triggers this action, the browser will send the getPendingIntent associated with this action. The Intent within the PendingIntent will include the current URL of the Custom Tab as its data, EXTRA_TRIGGERED_CUSTOM_CONTENT_ACTION_ID with the ID of this action, EXTRA_CLICKED_CONTENT_TARGET_TYPE with the type of content interacted with, and potentially other contextual extras (e.g., EXTRA_CONTEXT_IMAGE_URL).

Parameters
@NonNull CustomContentAction action

The CustomContentAction to add. Must not be null.
Returns
@NonNull CustomTabsIntent.Builder

This Builder.
Throws
java.lang.IllegalArgumentException

if an action with the same ID has already been added.

addDefaultShareMenuItem

Added in 1.2.0
Deprecated in 1.3.0
public @NonNull CustomTabsIntent.Builder addDefaultShareMenuItem()

Adds a default share item to the menu.

addMenuItem

Added in 1.2.0
public @NonNull CustomTabsIntent.Builder addMenuItem(@NonNull String label, @NonNull PendingIntent pendingIntent)

Adds a menu item.

Parameters
@NonNull String label

Menu label.
@NonNull PendingIntent pendingIntent

Pending intent delivered when the menu item is clicked.

addToolbarItem

Added in 1.2.0
Deprecated in 1.2.0
public @NonNull CustomTabsIntent.Builder addToolbarItem(
    int id,
    @NonNull Bitmap icon,
    @NonNull String description,
    @NonNull PendingIntent pendingIntent
)

Adds an action button to the custom tab. Multiple buttons can be added via this method. If the given id equals 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 TOOLBAR_ACTION_BUTTON_ID, it will be directly put on secondary toolbar. The maximum number of allowed toolbar items in a single intent is getMaxToolbarItems. Throws an IllegalStateException when that number is exceeded per intent.

Parameters
int id

The unique id of the action button. This should be non-negative.
@NonNull Bitmap icon

The icon.
@NonNull String description

The description for the button. To be used for accessibility.
@NonNull PendingIntent pendingIntent

The pending intent delivered when the button is clicked.
Throws
java.lang.IllegalStateException
See also
getMaxToolbarItems

build

Added in 1.2.0
public @NonNull CustomTabsIntent build()

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

enableUrlBarHiding

Added in 1.2.0
Deprecated in 1.3.0
public @NonNull CustomTabsIntent.Builder enableUrlBarHiding()

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

setActionButton

Added in 1.2.0
public @NonNull CustomTabsIntent.Builder setActionButton(
    @NonNull Bitmap icon,
    @NonNull String description,
    @NonNull PendingIntent pendingIntent
)

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

See also
setActionButton

setActionButton

Added in 1.2.0
public @NonNull CustomTabsIntent.Builder setActionButton(
    @NonNull Bitmap icon,
    @NonNull String description,
    @NonNull PendingIntent pendingIntent,
    boolean shouldTint
)

Sets the action button that is displayed in the Toolbar.

This is equivalent to calling addToolbarItem with TOOLBAR_ACTION_BUTTON_ID as id.

Parameters
@NonNull Bitmap icon

The icon.
@NonNull String description

The description for the button. To be used for accessibility.
@NonNull PendingIntent pendingIntent

pending intent delivered when the button is clicked.
boolean shouldTint

Whether the action button should be tinted..
See also
addToolbarItem

setActivitySideSheetBreakpointDp

Added in 1.8.0
public @NonNull CustomTabsIntent.Builder setActivitySideSheetBreakpointDp(@Dimension(unit = 0) int breakpointDp)

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

Parameters
@Dimension(unit = 0) int breakpointDp

The Custom Tab Activity's breakpoint in DP.
See also
EXTRA_ACTIVITY_SIDE_SHEET_BREAKPOINT_DP

setActivitySideSheetDecorationType

Added in 1.8.0
public @NonNull CustomTabsIntent.Builder setActivitySideSheetDecorationType(int decorationType)

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

Parameters
int decorationType

The Custom Tab Activity's decoration type.
See also
EXTRA_ACTIVITY_SIDE_SHEET_DECORATION_TYPE
ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DEFAULT
ACTIVITY_SIDE_SHEET_DECORATION_TYPE_NONE
ACTIVITY_SIDE_SHEET_DECORATION_TYPE_SHADOW
ACTIVITY_SIDE_SHEET_DECORATION_TYPE_DIVIDER

setActivitySideSheetMaximizationEnabled