WindowAreaInfo

@ExperimentalWindowApi
class WindowAreaInfo

The current state of a window area. The WindowAreaInfo can represent a part of or an entire display in the system. These values can be used to modify the UI to show/hide controls and determine when features can be enabled.

Summary

Nested types

Represents a type of WindowAreaInfo

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

Returns the current active WindowAreaSession is one is currently active for the provided operation
WindowAreaCapability

Returns the WindowAreaCapability corresponding to the operation provided.
open Int
open String

Public properties
WindowMetrics

The WindowMetrics that represent the size of the area.
Binder

Binder token to identify the specific WindowArea
WindowAreaInfo.Type

The Type of this window area

Public functions

equals

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

getActiveSession

Added in 1.2.0
fun getActiveSession(operation: WindowAreaCapability.Operation): WindowAreaSession?

Returns the current active WindowAreaSession is one is currently active for the provided operation

Throws
kotlin.IllegalStateException

if there is no active session for the provided operation

getCapability

Added in 1.2.0
fun getCapability(operation: WindowAreaCapability.Operation): WindowAreaCapability

Returns the WindowAreaCapability corresponding to the operation provided. If this WindowAreaCapability does not exist for this WindowAreaInfo, a WindowAreaCapability with a WINDOW_AREA_STATUS_UNSUPPORTED value is returned.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

metrics

Added in 1.2.0
var metrics: WindowMetrics

The WindowMetrics that represent the size of the area. Used to determine if the behavior desired fits the size of the window area available.

token

Added in 1.2.0
val token: Binder

Binder token to identify the specific WindowArea

type

Added in 1.2.0
val type: WindowAreaInfo.Type

The Type of this window area