WindowLayoutInfo

class WindowLayoutInfo

Contains the list of DisplayFeature-s present in the window and the window's engagement mode.

See also
windowLayoutInfo
WindowLayoutInfo.EngagementMode

Summary

Nested types

Represents a distinct user engagement mode with an application.

Public functions
open operator Boolean
equals(other: Any?)
Boolean

Checks if a specific engagement mode is currently active.
Boolean

Checks if all specified engagement modes are currently active.
open Int
open String

Public properties
List<DisplayFeature>

The display features that are present in the window.
Set<WindowLayoutInfo.EngagementMode>

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-alpha03
fun hasEngagementMode(mode: WindowLayoutInfo.EngagementMode): Boolean

Checks if a specific engagement mode is currently active.

Parameters
mode: WindowLayoutInfo.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-alpha03
fun hasEngagementModes(vararg modes: WindowLayoutInfo.EngagementMode): Boolean

Checks if all specified engagement modes are currently active.

Parameters
vararg modes: WindowLayoutInfo.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

displayFeatures

Added in 1.0.0
val displayFeatures: List<DisplayFeature>

The display features that are present in the window. It is an empty list if there are no display features.

engagementModes

Added in 1.6.0-alpha03
val engagementModes: Set<WindowLayoutInfo.EngagementMode>

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