Summary: Constants | Inherited Constants | Ctors | Methods | Inherited Methods

TrustedWebActivityDisplayMode.ImmersiveMode

Kotlin |Java

public static class TrustedWebActivityDisplayMode.ImmersiveMode
extends Object implements TrustedWebActivityDisplayMode

java.lang.Object
↳	androidx.browser.trusted.TrustedWebActivityDisplayMode.ImmersiveMode

Immersive mode: both the browser controls and the system UI (status bar, navigation bar) is hidden while the user is on a verified origin. See https://developer.android.com/training/system-ui/immersive Using this mode is different from using the JavaScript Fullscreen API in that the immersive mode will be entered immediately, before the page has loaded. If the app uses a splash screen, it will be displayed in immersive mode. It is not recommended to use both this API and the JavaScript API simultaneously.

Summary

Constants
`String`	`KEY_CUTOUT_MODE` Bundle key for `layoutInDisplayCutoutMode()`.
`String`	`KEY_STICKY` Bundle key for `isSticky()`.

Inherited constants

From interface androidx.browser.trusted.TrustedWebActivityDisplayMode

String

KEY_ID

Bundle key for the integer identifying the mode.

Public constructors
`ImmersiveMode(boolean isSticky, int layoutInDisplayCutoutMode)` Constructor.

Public methods
`boolean`	`isSticky()` Returns whether sticky immersive mode is enabled.
`int`	`layoutInDisplayCutoutMode()` Returns the cutout mode.
`Bundle`	`toBundle()` Packs the object into a `Bundle`.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          androidx.browser.trusted.TrustedWebActivityDisplayMode

`static TrustedWebActivityDisplayMode`	`fromBundle(Bundle bundle)` Unpacks the object from a `Bundle`.
`abstract Bundle`	`toBundle()` Packs the object into a `Bundle`.

Constants

KEY_CUTOUT_MODE

public static final String KEY_CUTOUT_MODE

Bundle key for layoutInDisplayCutoutMode().

Constant Value: "androidx.browser.trusted.displaymode.KEY_CUTOUT_MODE"

KEY_STICKY

public static final String KEY_STICKY

Bundle key for isSticky().

Constant Value: "androidx.browser.trusted.displaymode.KEY_STICKY"

Public constructors

ImmersiveMode

public ImmersiveMode (boolean isSticky, 
                int layoutInDisplayCutoutMode)

Constructor.

Parameters
`isSticky`	`boolean`: Whether the Trusted Web Activity should be in sticky immersive mode, see https://developer.android.com/training/system-ui/immersive#sticky-immersive
`layoutInDisplayCutoutMode`	`int`: The constant defining how to deal with display cutouts. See `WindowManager.LayoutParams.layoutInDisplayCutoutMode` and https://developer.android.com/guide/topics/display-cutout

Public methods

isSticky

public boolean isSticky ()

Returns whether sticky immersive mode is enabled.

Returns
`boolean`

layoutInDisplayCutoutMode

public int layoutInDisplayCutoutMode ()

Returns the cutout mode.

Returns
`int`

toBundle

public Bundle toBundle ()

Packs the object into a Bundle.

Returns
`Bundle`