WindowEngagementInfo

Artifact: androidx.window:window

View Source

Added in 1.6.0-alpha05

---

Kotlin |Java

class WindowEngagementInfo

---

Contains the window's engagement mode.

Summary

Nested types
class WindowEngagementInfo.EngagementMode Represents a distinct user engagement mode with an application.

Public functions
open operator Boolean	equals(other: Any?)
Boolean	hasEngagementMode(mode: WindowEngagementInfo.EngagementMode) Checks if a specific engagement mode is currently active.
Boolean	hasEngagementModes(vararg modes: WindowEngagementInfo.EngagementMode) Checks if all specified engagement modes are currently active.
open Int	hashCode()
open String	toString()

Public properties
Set<WindowEngagementInfo.EngagementMode>	engagementModes The current user engagement modes, indicating how the user is interacting with the app.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hasEngagementMode

Added in 1.6.0-alpha05

fun hasEngagementMode(mode: WindowEngagementInfo.EngagementMode): Boolean

Checks if a specific engagement mode is currently active.

Parameters
mode: WindowEngagementInfo.EngagementMode	The EngagementMode to check for.

Returns
Boolean	true if the mode is present in the engagementModes set, false otherwise.

hasEngagementModes

Added in 1.6.0-alpha05

fun hasEngagementModes(vararg modes: WindowEngagementInfo.EngagementMode): Boolean

Checks if all specified engagement modes are currently active.

Parameters
vararg modes: WindowEngagementInfo.EngagementMode	The EngagementMode-s to check for.

Returns
Boolean	true if all specified modes are in the engagementModes set, false otherwise.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

engagementModes

Added in 1.6.0-alpha05

val engagementModes: Set<WindowEngagementInfo.EngagementMode>

The current user engagement modes, indicating how the user is interacting with the app.