System Values allow you to access read-only app values, such as the current time or the app version. The complete list of supported System Values follows.
| Name | Expression | Description / Platform(s) |
|---|---|---|
| App ID | [[sys:appID]] | A unique number assigned by EachScape to each application. Platforms: Android, iOS, Web |
| AppStore Name | [[sys:installerPackageName]] | Resolves to the name of the app store you received this app from. If your app is distributed via the Google App Store, this value will be 'com.google.vending'. If your app is distributed via the Amazon App Store, this value will be 'com.amazon.venezia'. If your app is distributed via NEITHER of these means, it will be an empty string "" Platforms: Android |
| Area Below Safe Area | [[sys:safeAreaBottom]] | On devices with a "safe area," such as the iPhone X, sys:safeAreaBottom returns the number of points between the bottom of the safe area and the bottom of the screen. Interactive UI elements should be placed at at least this many points above the bottom of the screen. Note: this System Value has an issue where the value reported may be incorrect when switching between portrait and landscape views; we are working to resolve it. Platforms: Android |
| Beacon Accuracy | [[beacon:accuracy]] | This is the distance, in meters, to the nearest Beacon. Platforms: Android, iOS |
| Beacon Major | [[beacon:major]] | This is the value of the major of the nearest Beacon. Platforms: Android, iOS |
| Beacon Minor | [[beacon:minor]] | This is the value of the minor of the closest Beacon Platforms: Android, iOS |
| Bluetooth Status | [[sys:bluetoothStatus]] | THIS VALUE IS ONLY ENABLED when your app uses the "Bluetooth Status Monitor" action. If you don't use that action, this token will expand to "Bluetooth Status Monitor not activated". Expands to one of four possible values: "Bluetooth Status Monitor not activated" => You must use the "Bluetooth Status Monitor" action in your app somewhere. "enabled" => Bluetooth is on. "disabled" => Bluetooth is off. "unavailable" => Your device does not support Bluetooth. Platforms: Android, iOS |
| Bundle Identifier | [[sys:bundleIdentifier]] | For iOS, this returns the Bundle Identifier. For Android apps, this returns the Package Name. Platforms: Android, iOS |
| Carrier | [[sys:carrier]] | When possible to determine, this string identifies the network carrier, otherwise it is blank. Platforms: Android |
| CD Patch Level | [[sys:patchLevel]] | Provide the Content Distribution Path Level in use Platforms: Android, iOS |
| Charger Status | [[sys:chargerStatus]] | Reports connected if the charger is connected, disconnected if it is disconnected. This value can be used, for example to dim the screen when the charger is disconnected in conjunction with the app level event charger status changed and device brightness can be changed with "Set a Property Action" for app/deviceBrightness ranging from 0.0 to 1.0. Platforms: iOS |
| Country | [[sys:country]] | The country code derived from the device's primary or current language setting. Platforms: Android, iOS, Web |
| Device Available View Height | [[sys:deviceAvailableViewHeight]] | The height of the current view that is available for laying out blocks. If the view has an opaque status bar, deviceAvailableViewHeight will give the height of the screen less the height of the status bar. If the status bar is transparent, its height will be included in deviceAvailableViewHeight since blocks can be laid out underneath the transparent status bar. On Android, if the soft keys are covering part of the bottom of the screen their height will be subtracted from deviceAvailableViewHeight. > Tutorial: Create Adaptive UI Platforms: Android, iOS, Web |
| Device Available View Width | [[sys:deviceAvailableViewWidth]] | The width of the current view that is available for laying out blocks. On Android, if the soft keys are covering part of the side of the screen their width will be subtracted from deviceAvailableViewWidth. Tutorial: Create Adaptive UI Platforms: Android, iOS, Web |
| Device Class | [[sys:deviceClass]] | Returns the string "handheld", "tablet" , "tv" and "unknown" for a web browser. Platforms: Android, iOS, Web |
| Device Date and Time (GMT) | [[sys:gmtTime]] | The current date and time in the UTC (GMT) time zone based on the device's current time setting. Working with Date and Time Format Date and Time Platforms: Android, iOS, Web |
| Device Date and Time (local) | [[sys:localTime]] | The current date and time set on the device, in the time zone chosen by the user of the device. Working with Date and Time Format Date and Time Platforms: Android, iOS, Web |
| Device Landscape Height | [[sys:deviceLandscapeHeight]] | The height of the device screen in landscape orientation, measured in DIPs or points. Another, more versatile system value is : deviceAvailableViewHeight Tutorial: Create Adaptive UI Platforms: Android, iOS, Web |
| Device Landscape Width | [[sys:deviceLandscapeWidth]] | The width of the device screen in landscape orientation, measured in DIPs or points. Another, more versatile system value is : deviceAvailableViewWidth Tutorial: Create Adaptive UI Platforms: Android, iOS, Web |
| Device Language | [[sys:deviceLanguage]] | The two letter lower-case language code of the device's current language Platforms: Android, iOS |
| Device Latitude | [[var:_deviceLatitude]] | The device's current Latitude. Platforms: Android, iOS, Web |
| Device Longitude | [[var:_deviceLongitude]] | The device's current longitude. Platforms: Android, iOS, Web |
| Device Orientation | [[sys:orientation]] | The string "landscape" or "portrait", depending on the device orientation. Platforms: Android, iOS, Web |
| Device Orientation Specific | [[sys:specificOrientation]] | The string "landscapeLeft", "landscapeRight", "portrait" or "portraitUpsideDown", depending on the device orientation. Platforms: (none) |
| Device Pixel Density | [[sys:devicePixelDensity]] | The pixels per inch on the display. Platforms: Android, iOS |
| Device Portrait Height | [[sys:devicePortraitHeight]] | The height of the device screen in portrait orientation, measured in DIPs or points. Another, more versatile system value is : deviceAvailableViewHeight Tutorial: Create Adaptive UI Platforms: Android, iOS, Web |
| Device Portrait Width | [[sys:devicePortraitWidth]] | The width of the device screen in portrait orientation, measured in DIPs or points. Another, more versatile system value is : deviceAvailableViewWidth Tutorial: Create Adaptive UI Platforms: Android, iOS, Web |
| Device Token (for Push) | [[var:_deviceToken]] | A unique identifier used by the push notification delivery system. It is only present when push notification is configured and supported by he device. Platforms: Android, iOS |
| Facebook ID | [[sys:facebookId]] | The unique ID assigned to the user's Facebook account. This is only available when the user is logged into Facebook. Platforms: Android, iOS |
| Facebook Name | [[sys:facebookUsername]] | The name associated with the user's Facebook account. This is only available when the user is logged into Facebook. Platforms: Android, iOS |
| Facebook Picture | [[sys:facebookPicture]] | A URL (?) or serialized image from the user's Facebook profile. This is only available when the user is logged into Facebook. Platforms: Android, iOS |
| Network Status | [[sys:networkStatus]] | The text string "none", "wifi" or "cell", depending on the network connection type. Platforms: Android, iOS, Web |
| OS | [[sys:os]] | The string "ios", "android" or "web", depending on the platform for which the app was built. Platforms: Android, iOS, Web |
| OS Version | [[sys:osVersion]] | Returns the operating system version, when available. Platforms: Android, iOS |
| Push Device Token | [[sys:pushNotificationDeviceToken]] | A unique identifier used by the push notification delivery system. It is only present when push notification is configured and supported by he device. Platforms: Android, iOS |
| Push Extra Data | [[push:extra]] | When using EachScape as your push notification provider, [[push:extra]] returns the value of the "Extra data" field for the push notification a user tapped on to launched the app. Meant to be used in the Push Notification app event. Platforms: Android, iOS |
| Push Msg Contents | [[sys:pushAlert]] | The contents of the last push notification received since the app launched. This value is undefined if no push messages have been received since the app launched. Platforms: Android, iOS |
| Twitter Picture | [[sys:twitterPicture]] | The serialized picture associated with the active Twitter account. This is only available when the user is logged into Twitter. Platforms: Android, iOS |
| Twitter Username | [[sys:twitterUsername]] | The username associated with the active Twitter account. This is only available when the user is logged into Twitter. Platforms: Android, iOS |
| Unique Device ID | [[var:_deviceIdentifier]] | A unique identifier associated with the device. On iOS..., on Android... Platforms: Android, iOS |
| Version and Build | [[sys:version]] | A string identifying the version of the app, such as "1.14.2" Platforms: Android, iOS, Web |
| View Name for Reports | [[sys:viewReportingName]] | The name of the current View that will be returned to the reporting system. This may differ from the actual View name if you have also filled in the "View Reporting Name" field in the View Edit page. Platforms: Android, iOS |