TrustedWebActivityIntentBuilder

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

Extra for the Trusted Web Activity launch Intent to specify a list of origins for the browser to treat as trusted, in addition to the origin of the launching URL. It is recommended to use TrustedWebActivityIntentBuilder instead of manually piecing the Intent together.

const val EXTRA_DISPLAY_MODE = "androidx.browser.trusted.extra.DISPLAY_MODE": String!

Extra for the TrustedWebActivityDisplayMode, see setDisplayMode.

const val EXTRA_SCREEN_ORIENTATION = "androidx.browser.trusted.extra.SCREEN_ORIENTATION": String!

Extra for the screenOrientation, see setScreenOrientation.

const val EXTRA_SHARE_DATA = "androidx.browser.trusted.extra.SHARE_DATA": String!

Extra for the share data, see setShareParams.

const val EXTRA_SHARE_TARGET = "androidx.browser.trusted.extra.SHARE_TARGET": String!

Extra for the share target, see setShareParams.

const val EXTRA_SPLASH_SCREEN_PARAMS = "androidx.browser.trusted.EXTRA_SPLASH_SCREEN_PARAMS": String!

Extra for the Trusted Web Activity launch Intent to specify a Bundle of parameters for the browser to use in constructing a splash screen. It is recommended to use TrustedWebActivityIntentBuilder instead of manually piecing the Intent together.

TrustedWebActivityIntentBuilder(uri: Uri)

Creates a Builder given the required parameters.

fun build(session: CustomTabsSession): TrustedWebActivityIntent

Builds an instance of TrustedWebActivityIntent.

fun buildCustomTabsIntent(): CustomTabsIntent

Builds a CustomTabsIntent based on provided parameters. Can be useful for falling back to Custom Tabs when Trusted Web Activity providers are unavailable.

fun getDisplayMode(): TrustedWebActivityDisplayMode

Returns TrustedWebActivityDisplayMode set on this Builder.

fun getUri(): Uri

Returns the Uri to be launched with this Builder.

fun setAdditionalTrustedOrigins(origins: (Mutable)List<String!>): TrustedWebActivityIntentBuilder

Sets a list of additional trusted origins that the user may navigate or be redirected to from the starting uri. For example, if the user starts at https://www.example.com/page1 and is redirected to https://m.example.com/page2, and both origins are associated with the calling application via the Digital Asset Links, then pass "https://www.example.com/page1" as uri and Arrays.asList("https://m.example.com") as additionalTrustedOrigins. Alternatively, use validateRelationship to validate additional origins asynchronously, but that would delay launching the Trusted Web Activity.

fun setColorScheme(colorScheme: Int): TrustedWebActivityIntentBuilder

Sets the color scheme, see setColorScheme. In Trusted Web Activities color scheme may affect such UI elements as info bars and context menus.

fun setColorSchemeParams(
    colorScheme: Int,
    params: CustomTabColorSchemeParams
): TrustedWebActivityIntentBuilder

Sets CustomTabColorSchemeParams for the given color scheme. This allows, for example, to set two navigation bar colors - for light and dark scheme. Trusted Web Activity will automatically apply the correct color according to current system settings. For more details see setColorSchemeParams.

fun setDefaultColorSchemeParams(params: CustomTabColorSchemeParams): TrustedWebActivityIntentBuilder

Sets the default CustomTabColorSchemeParams. This will set a default color scheme that applies when no CustomTabColorSchemeParams specified for current color scheme via setColorSchemeParams.

fun setDisplayMode(displayMode: TrustedWebActivityDisplayMode): TrustedWebActivityIntentBuilder

Sets a TrustedWebActivityDisplayMode. This can be used e.g. to enable immersive mode (see TrustedWebActivityDisplayMode.ImmersiveMode. Not setting it means TrustedWebActivityDisplayMode.DefaultMode will be used.

fun setNavigationBarColor(color: @ColorInt Int): TrustedWebActivityIntentBuilder

Sets the navigation bar color, see setNavigationBarColor.

fun setNavigationBarDividerColor(color: @ColorInt Int): TrustedWebActivityIntentBuilder

Sets the navigation bar divider color, see setNavigationBarDividerColor.

fun setScreenOrientation(orientation: Int): TrustedWebActivityIntentBuilder

Sets a screenOrientation. This can be used e.g. to enable the locking of an orientation lock type ScreenOrientation.

fun setShareParams(shareTarget: ShareTarget, shareData: ShareData): TrustedWebActivityIntentBuilder

Sets the parameters for delivering data to a Web Share Target via a Trusted Web Activity.

fun setSplashScreenParams(splashScreenParams: Bundle): TrustedWebActivityIntentBuilder

Sets the parameters of a splash screen shown while the web page is loading, such as background color. See SplashScreenParamKey for a list of supported parameters. To provide the image for the splash screen, use transferSplashImage, prior to launching the intent. It is recommended to also show the same splash screen in the app as soon as possible, prior to establishing a CustomTabConnection. The Trusted Web Activity provider should ensure seamless transition of the splash screen from the app onto the top of webpage being loaded. The splash screen will be removed on the first paint of the page, or when the page load fails.

fun setToolbarColor(color: @ColorInt Int): TrustedWebActivityIntentBuilder

Sets the color applied to the toolbar and the status bar, see setToolbarColor. When a Trusted Web Activity is on the verified origin, the toolbar is hidden, so the color applies only to the status bar. When it's on an unverified origin, the toolbar is shown, and the color applies to both toolbar and status bar.