Platform QML Type

Contains miscellaneous platform interaction utilities. More...

Import Statement: import ArcGIS.AppFramework.Platform 1.0

Properties

Signals

Methods

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 property 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.


[read-only] systemTheme : SystemTheme

Contains the currently used system theme.


Signal Documentation

stayAwakeError(StayAwakeErrorStatus status)

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

Note: The corresponding handler is onStayAwakeError.


Method Documentation

openSettings()

(BETA) Open app permission settings to manage permission access levels. This method is supported only on Android and iOS.


openSettings(object options)

(BETA) Open app permission settings to manage permission access levels. This method is supported only on Android and iOS.

The options parameter

This parameter is reserved for future use.


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.