standard.feInfo
Queries general front-end properties.
Syntax
ui.Interface.frontCall("standard", "feInfo",
[name], [result])
- name - The name of the property.
- result - The value of the property.
Usage
The feInfo
front call returns a front-end property value depending on the
property name passed in as the parameter.
feInfo
options take an optional parameter, such as
screenResolution
:CALL ui.Interface.frontCall("standard", "feInfo", ["screenResolution", 2], [resolution])
Property name | Description |
---|---|
colorScheme |
Returns the current brightness mode of the display device / user agent. The possible values returned are: |
dataDirectory |
Returns the directory name that can be used for temporary files on the front-end side. This directory is cleaned at front-end start-up and end, and is common to all front-end instances. The possible values returned are:
|
deviceModel |
Returns the name of the device, for example "iPad4,5". |
deviceId |
|
feName |
The code identifying the type of front-end component.
Tip: To save a network round
trip, it is recommended to use The possible values returned are:
|
fePath |
The installation directory of the front-end executable.
Important:
The installation path returned by this front call may change in future versions, do not base application code on this. On mobile devices, consider using the os.Path.pwd utility function to get the application working directory when executing programs. |
freeStorageSpace |
Returns the number of bytes available on the (mobile) device. |
ip |
Returns the IP address of the network interface used for the GUI connection. For mobile platforms, this is the preferred IP address of the device. If there is WIFI, either
the IPv4 address is returned (for example: |
numScreens |
Number of screens available on the front-end platform. On typical front-end platforms and devices, the number of screens is 1. In some rare cases, a desktop computer can be configured with more than one screen. |
osType |
The operating system type where the front-end is running. Possible return values include " |
osVersion |
The version of the operating system. Example of returned values: " |
ppi |
Returns the screen pixel density of the front-end platform (Pixels Per Inch). This front call takes an optional screen number as parameter (1 is the default).
|
screenResolution |
Returns the screen resolution of the front-end platform. This front call takes an optional screen number as parameter (1 is the default). Example of returned values: " Note:
For mobile devices, the value can change depending on the device orientation. |
target |
Returns the build platform target code name, identifying the operating system the front-end
binary was compiled. This front call is provided for debugging purpose, do not base code on the
returned value, it can change if the target OS version is upgraded for example. Use the
Example of returned values:
|
windowSize |
Returns the current size of the front-end view-port.
Example of returned values: " |
userPreferredLang |
Returns the language and territory of the locale defined on the front-end platform, in the
|