Skip To Content

Platform QML Type

Contains miscellaneious platform interaction utilities. More...

Import Statement: import ArcGIS.AppFramework.Platform 1.0

Properties

Signals

Detailed Description

The Platform component provides a global object with useful utility functions for working with platform-specific functions.

This component is a singleton, and does not need to be instantiated.

Enumerations

StayAwakeErrorStatus enumeration

Enum describing the error status of the process of keeping the device active. Informs the stayAwakeError signal.

NameValue
Platform.StayAwakeSuccess0
Platform.StayAwakeFailed1
Platform.StayAwakeApplicationHidden2
Platform.StayAwakePlatformNotSupported3

Property Documentation

stayAwake : bool

If set to true, the app will continuously prevent the device from going to sleep.

This functionality is not available on Linux.

This function will only work when the app is running in the foreground. Because of this, it's recommended to set this property to false before the app is minimized or closed.


Signal Documentation

stayAwakeError( StayAwakeErrorStatus status)

Signal emitted when the process of keeping the device active encounters an error. Informed by the StayAwakeErrorStatus enum.