By.Window

Artifact: androidx.test.uiautomator:uiautomator

Kotlin |Java

class By.Window

This nested class is used to create a ByWindowSelector that matches a window.

Summary

Public functions
`java-static ByWindowSelector`	`active(isActive: Boolean)` Constructs a new `ByWindowSelector` and sets the active criteria.
`java-static ByWindowSelector`	`@RequiresApi(value = 30) displayId(displayId: Int)` Constructs a new `ByWindowSelector` and sets the display ID criteria.
`java-static ByWindowSelector`	`focused(isFocused: Boolean)` Constructs a new `ByWindowSelector` and sets the focused criteria.
`java-static ByWindowSelector`	`id(id: Int)` Constructs a new `ByWindowSelector` and sets the window id criteria.
`java-static ByWindowSelector`	`layer(layer: @IntRange(from = 0) Int)` Constructs a new `ByWindowSelector` and sets the layer (Z-order) criteria.
`java-static ByWindowSelector`	`layerAbove(referenceLayer: @IntRange(from = 0) Int)` Constructs a new `ByWindowSelector` and sets the layer (Z-order) criteria.
`java-static ByWindowSelector`	`layerBelow(referenceLayer: @IntRange(from = 1) Int)` Constructs a new `ByWindowSelector` and sets the layer (Z-order) criteria.
`java-static ByWindowSelector`	`pkg(packageName: String)` Constructs a new `ByWindowSelector` and sets the package criteria.
`java-static ByWindowSelector`	`pkg(regex: Pattern)` Constructs a new `ByWindowSelector` and sets the package criteria.
`java-static ByWindowSelector`	`title(regex: Pattern)` Constructs a new `ByWindowSelector` and sets the title criteria.
`java-static ByWindowSelector`	`title(title: String)` Constructs a new `ByWindowSelector` and sets the title criteria.
`java-static ByWindowSelector`	`titleContains(substring: String)` Constructs a new `ByWindowSelector` and sets the title criteria.
`java-static ByWindowSelector`	`titleEndsWith(suffix: String)` Constructs a new `ByWindowSelector` and sets the title criteria.
`java-static ByWindowSelector`	`titleStartsWith(prefix: String)` Constructs a new `ByWindowSelector` and sets the title criteria.
`java-static ByWindowSelector`	`type(type: Int)` Constructs a new `ByWindowSelector` and sets the type criteria.

Public functions

active

Added in 2.4.0-alpha06

java-static fun active(isActive: Boolean): ByWindowSelector

Constructs a new ByWindowSelector and sets the active criteria.

See also
`active`	ByWindowSelector.active(boolean)

displayId

Added in 2.4.0-alpha06

@RequiresApi(value = 30)
java-static fun displayId(displayId: Int): ByWindowSelector

Constructs a new ByWindowSelector and sets the display ID criteria.

See also
`displayId`	ByWindowSelector.displayId(int)

focused

Added in 2.4.0-alpha06

java-static fun focused(isFocused: Boolean): ByWindowSelector

Constructs a new ByWindowSelector and sets the focused criteria.

See also
`focused`	ByWindowSelector.focused(boolean)

id

Added in 2.4.0-alpha06

java-static fun id(id: Int): ByWindowSelector

Constructs a new ByWindowSelector and sets the window id criteria.

The window id can be obtained from getId.

See also
`id`	ByWindowSelector.id(int)

layer

Added in 2.4.0-alpha06

java-static fun layer(layer: @IntRange(from = 0) Int): ByWindowSelector

Constructs a new ByWindowSelector and sets the layer (Z-order) criteria.

The layer ID can be obtained from getLayer.

See also
`layer`	ByWindowSelector.layer(int)

layerAbove

Added in 2.4.0-alpha06

java-static fun layerAbove(referenceLayer: @IntRange(from = 0) Int): ByWindowSelector

Constructs a new ByWindowSelector and sets the layer (Z-order) criteria.

The referenced layer ID can be obtained from getLayer.

See also
`layerAbove`	ByWindowSelector.layerAbove(int)

layerBelow

Added in 2.4.0-alpha06

java-static fun layerBelow(referenceLayer: @IntRange(from = 1) Int): ByWindowSelector

Constructs a new ByWindowSelector and sets the layer (Z-order) criteria.

The referenced layer ID can be obtained from getLayer.

See also
`layerBelow`	ByWindowSelector.layerBelow(int)

pkg

Added in 2.4.0-alpha06

java-static fun pkg(packageName: String): ByWindowSelector

Constructs a new ByWindowSelector and sets the package criteria.

See also
`pkg`	ByWindowSelector.pkg(String)

pkg

Added in 2.4.0-alpha06

java-static fun pkg(regex: Pattern): ByWindowSelector

Constructs a new ByWindowSelector and sets the package criteria.

See also
`pkg`	ByWindowSelector.pkg(Pattern)