DeviceActions

public final class DeviceActions

Summary

Public methods
static final @NonNull DeviceAction

Set device screen to be folded with the hinge in the vertical position.
static final @NonNull DeviceAction

Set device screen to be closed.
static final @NonNull DeviceAction
setDisplaySize(
    @NonNull WidthSizeClass widthSizeClass,
    @NonNull HeightSizeClass heightSizeClass
)

Set device's window size.
static final @NonNull DeviceAction

Set device screen to be completely flat, like a tablet.
static final @NonNull DeviceAction

Set device's screen orientation.
static final @NonNull DeviceAction

Set device screen to be folded with the hinge in the horizontal position.

Public methods

setBookMode

public static final @NonNull DeviceAction setBookMode()

Set device screen to be folded with the hinge in the vertical position. For details on foldable postures, see https://developer.android.com/guide/topics/large-screens/learn-about-foldables#foldable_postures

This action is for foldable devices only. Currently only supported for tests run on Android Emulators.

Throws
androidx.test.platform.device.UnsupportedDeviceOperationException

if used on a real device.
androidx.test.espresso.device.controller.DeviceControllerOperationException

when called on a non-foldable Emulator.

setClosedMode

public static final @NonNull DeviceAction setClosedMode()

Set device screen to be closed.

This action is for foldable devices only. Currently only supported for tests run on Android Emulators.

Throws
androidx.test.platform.device.UnsupportedDeviceOperationException

if used on a real device.
androidx.test.espresso.device.controller.DeviceControllerOperationException

when called on a non-foldable Emulator.

setDisplaySize

public static final @NonNull DeviceAction setDisplaySize(
    @NonNull WidthSizeClass widthSizeClass,
    @NonNull HeightSizeClass heightSizeClass
)

Set device's window size.

Parameters
@NonNull WidthSizeClass widthSizeClass

the window width to set the device to
@NonNull HeightSizeClass heightSizeClass

the window height to set the device to

setFlatMode

public static final @NonNull DeviceAction setFlatMode()

Set device screen to be completely flat, like a tablet. For details on foldable postures, see https://developer.android.com/guide/topics/large-screens/learn-about-foldables#foldable_postures

This action is for foldable devices only. Currently only supported for tests run on Android Emulators.

Throws
androidx.test.platform.device.UnsupportedDeviceOperationException

if used on a real device.
androidx.test.espresso.device.controller.DeviceControllerOperationException

when called on a non-foldable Emulator.

setScreenOrientation

public static final @NonNull DeviceAction setScreenOrientation(@NonNull ScreenOrientation orientation)

Set device's screen orientation.

Parameters
@NonNull ScreenOrientation orientation

the orientation to set the device to (portait or landscape)

setTabletopMode

public static final @NonNull DeviceAction setTabletopMode()

Set device screen to be folded with the hinge in the horizontal position. For details on foldable postures, see https://developer.android.com/guide/topics/large-screens/learn-about-foldables#foldable_postures

This action is for foldable devices only. Currently only supported for tests run on Android Emulators.

Throws
androidx.test.platform.device.UnsupportedDeviceOperationException

if used on a real device.
androidx.test.espresso.device.controller.DeviceControllerOperationException

when called on a non-foldable Emulator.