# TrustedWebActivityDisplayMode.ImmersiveMode

Artifact: [androidx.browser:browser](https://developer.android.com/jetpack/androidx/releases/browser) [View Source](https://cs.android.com/search?q=file:androidx/browser/trusted/TrustedWebActivityDisplayMode.java+class:androidx.browser.trusted.TrustedWebActivityDisplayMode.ImmersiveMode) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)

*** ** * ** ***


```
class TrustedWebActivityDisplayMode.ImmersiveMode : TrustedWebActivityDisplayMode
```

<br />

*** ** * ** ***

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 |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#KEY_CUTOUT_MODE() = "androidx.browser.trusted.displaymode.KEY_CUTOUT_MODE"` Bundle key for `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#layoutInDisplayCutoutMode()`. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#KEY_STICKY() = "androidx.browser.trusted.displaymode.KEY_STICKY"` Bundle key for `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#isSticky()`. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#ImmersiveMode(boolean,int)(isSticky: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, layoutInDisplayCutoutMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Constructor. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#isSticky()()` Returns whether sticky immersive mode is enabled. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#layoutInDisplayCutoutMode()()` Returns the cutout mode. |
| `https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#toBundle()()` Packs the object into a `https://developer.android.com/reference/android/os/Bundle.html`. |

| ### Inherited Constants |
|---|
| From [androidx.browser.trusted.TrustedWebActivityDisplayMode](https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode) |---|---| | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode#KEY_ID() = "androidx.browser.trusted.displaymode.KEY_ID"` Bundle key for the integer identifying the mode. | |

## Constants

### KEY_CUTOUT_MODE

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)

```
const val KEY_CUTOUT_MODE = "androidx.browser.trusted.displaymode.KEY_CUTOUT_MODE": String!
```

Bundle key for `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#layoutInDisplayCutoutMode()`.

### KEY_STICKY

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)

```
const val KEY_STICKY = "androidx.browser.trusted.displaymode.KEY_STICKY": String!
```

Bundle key for `https://developer.android.com/reference/kotlin/androidx/browser/trusted/TrustedWebActivityDisplayMode.ImmersiveMode#isSticky()`.

## Public constructors

### ImmersiveMode

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)

```
ImmersiveMode(isSticky: Boolean, layoutInDisplayCutoutMode: Int)
```

Constructor.

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

## Public functions

### isSticky

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)

```
fun isSticky(): Boolean
```

Returns whether sticky immersive mode is enabled.

### layoutInDisplayCutoutMode

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/browser#1.2.0)

```
fun layoutInDisplayCutoutMode(): Int
```

Returns the cutout mode.

### toBundle

```
fun toBundle(): Bundle
```

Packs the object into a `https://developer.android.com/reference/android/os/Bundle.html`.