System

Enterprise Browser 1.7

Overview

The System API is used to control and modify core aspects of the device such as the screen, OS and device capabilities.

Enabling the API

There are two methods of enabling the System API:

  • Include all ebapi modules
  • Include only the required API modules

For either of these methods, you'll need to include files from the /Enterprise Browser/JavaScript Files/Enterprise Browser directory on the computer that you installed the Enterprise Browser.

Include all JS API modules

To include all JS APIs, copy the ebapi-modules.js file to a location accessible by the app's files and include a reference to the JavaScript file in the app's HTML. For instance, to include the modules file in the app's index.html, copy the file to the same directory as that index.html and add the following line to the HTML's HEAD section:


<script type="text/javascript" charset="utf-8" src="ebapi-modules.js"></script>

Note: that the pathing for this file is relative to the current page.

This will define the EB class within the page. Any page you need to use the modules will need to have the .js file included in this fashion.

Include only the required modules

To include single APIs, you must first include the ebapi.js in your HTML as well as the API file you want to use. For instance, to use the System API, I would add the following code to my HTML file(s), assuming the API files have been copied to the same directory as the HTML.


<script type="text/javascript" charset="utf-8" src="ebapi.js"></script>
<script type="text/javascript" charset="utf-8" src="eb.system.js"></script>

The ebapi.js file is necessary for all single API inclusions.

Methods

applicationInstall(STRING applicationUrl)

Install an application.

Parameters

  • applicationUrl : STRING

    The url of an application to install on the device.

  • callback : CallBackHandler

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.System.applicationInstall(STRING applicationUrl)

applicationUninstall(STRING applicationName)

Uninstall the application. Not Supported on Windows CE devices.

Parameters

  • applicationName : STRING

    The name of the application.

  • callback : CallBackHandler

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.System.applicationUninstall(STRING applicationName)

bringToFront()

Bring application window to the top of the screen.

Parameters

  • callback : CallBackHandler

Returns

Synchronous Return:

  • Void

Platforms

  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.System.bringToFront()

clearNetworkStatusNotify()

Use Network.clearStatusNotify: Clear network status callback.

Parameters

  • callback : CallBackHandler

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.System.clearNetworkStatusNotify()

deleteFolder(STRING pathToFolder)

Delete folder.

Parameters

  • pathToFolder : STRING

    Path to folder.

  • callback : CallBackHandler

Returns

Synchronous Return:

  • Void

Platforms

  • Android
  • Windows Mobile

Method Access:

  • Class Method: This method can only be accessed via the API class object.
    • EB.System.deleteFolder(STRING pathToFolder)

deleteRegistrySetting(HASH propertyMap)

Deletes the specified value from the device registry. Only applicable on Windows Mobile / Embedded Handheld and CE devices.

Parameters

  • propertyMap : HASH

    Map of properties associated with the registry key being set.

    • hive : STRING

      The hive name, setRegistrySetting.

    • key : STRING

      Full path of the key, including '\' separators as required. Remember to use '\\' in JavaScript to specify backslash.

    • setting : STRING

      The name of the setting to be deleted.

    • persistent : BOOLEAN

      If the registry value was set to be persistent, ie a corresponding .reg file was created in the \Application folder then setting true here will delete that .reg file.

  • callback : CallBackHandler

Callback

Async Callback Returning Parameters: BOOLEAN

    Returns

    Synchronous Return:

    • BOOLEAN : Whether or not the registry key was successfully deleted.

    Platforms

    • Windows Mobile

    Method Access:

    • Class Method: This method can only be accessed via the API class object.
      • EB.System.deleteRegistrySetting(HASH propertyMap)

    exit()

    Use Application.quit: exit application.

    Parameters

    • callback : CallBackHandler

    Returns

    Synchronous Return:

    • Void

    Platforms

    • Android
    • Windows Mobile

    Method Access:

    • Class Method: This method can only be accessed via the API class object.
      • EB.System.exit()

    getAllProperties()

    This method will return all of object/value pairs for the propertyNames of the API class.

    Parameters

    • callback : CallBackHandler

    Callback

    Async Callback Returning Parameters: HASH

      • : STRING

    Returns

    Synchronous Return:

    • HASH : Map of all available properties
      • : STRING

    Platforms

    • Android
    • Windows Mobile

    Method Access:

    • Class Method: This method can only be accessed via the API class object.
      • EB.System.getAllProperties()

    getProperties(ARRAY arrayofNames)

    This method will return a set of object/value pairs for the list of the propertyName that is passed in. The propertyNames must be a valid property of the API class.

    Parameters

    • arrayofNames : ARRAY

      List of properties I want to know about

      • Object : STRING

    • callback : CallBackHandler

    Callback

    Async Callback Returning Parameters: HASH

      • : STRING

    Returns

    Synchronous Return:

    • HASH : Map of properties I want to know about
      • : STRING

    Platforms

    • Android
    • Windows Mobile

    Method Access:

    • Class Method: This method can only be accessed via the API class object.
      • EB.System.getProperties(ARRAY arrayofNames)

    getProperty(STRING propertyName)

    This method will return the value of the propertyName that is passed in. The propertyName must be a valid property of the API class.

    Parameters

    • propertyName : STRING

      The property to return info about.

    • callback : CallBackHandler

    Callback

    Async Callback Returning Parameters: STRING

      Returns

      Synchronous Return:

      • STRING : The property to return info about.

      Platforms

      • Android
      • Windows Mobile

      Method Access:

      • Class Method: This method can only be accessed via the API class object.
        • EB.System.getProperty(STRING propertyName)

      getRegistrySetting(HASH propertyMap)

      Retrieve a value from the device registry. Only applicable on Windows Mobile / Embedded Handheld and CE devices.

      Parameters

      • propertyMap : HASH

        Map of properties associated with the registry key being set.

        • hive : STRING

          The hive name, see setRegistrySetting.

        • key : STRING

          Full path of the key, including '\' separators as required. Remember to use '\\' in JavaScript to specify backslash.

        • setting : STRING

          The name of the setting to be retrieved.

      • callback : CallBackHandler

      Callback

      Async Callback Returning Parameters: STRING

        Returns

        Synchronous Return:

        • STRING : Registry value of the key.

        Platforms

        • Windows Mobile

        Method Access:

        • Class Method: This method can only be accessed via the API class object.
          • EB.System.getRegistrySetting(HASH propertyMap)

        getStartParams()

        Return the command line parameters. At Android start parameters are returned as URL query string starting with '?', name-value delimiter '=' and name value pairs delimiter '&'.

        Parameters

        • callback : CallBackHandler

        Callback

        Async Callback Returning Parameters: STRING

          Returns

          Synchronous Return:

          • Void

          Platforms

          • Android
          • Windows Mobile
          • Windows CE

          Method Access:

          • Class Method: This method can only be accessed via the API class object.
            • EB.System.getStartParams()

          get_locale()

          Use System.locale property: Current device locale.

          Parameters

          • callback : CallBackHandler

          Callback

          Async Callback Returning Parameters: STRING

            Returns

            Synchronous Return:

            • STRING

            Platforms

            • Android
            • Windows Mobile

            Method Access:

            • Class Method: This method can only be accessed via the API class object.
              • EB.System.get_locale()

            hideSplashScreen()

            Hide Splash Screen if delay is configured as -1 in rhoconfig.txt

            Parameters

            • callback : CallBackHandler

            Returns

            Synchronous Return:

            • Void

            Platforms

            • Android

            Method Access:

            • Class Method: This method can only be accessed via the API class object.
              • EB.System.hideSplashScreen()

            isApplicationInstalled(STRING applicationName)

            Checks if the specified applicationName is installed on the device.

            Parameters

            • applicationName : STRING

              The name of the application.

            • callback : CallBackHandler

            Callback

            Async Callback Returning Parameters: BOOLEAN

              Returns

              Synchronous Return:

              • BOOLEAN

              Platforms

              • Android
              • Windows Mobile

              Method Access:

              • Class Method: This method can only be accessed via the API class object.
                • EB.System.isApplicationInstalled(STRING applicationName)

              isBlobAttr(STRING partition, INTEGER sourceID, STRING attrName)

              Use Database.SQLite3.isBlobAttr: is model attribute is blob.

              Parameters

              • partition : STRING

              • sourceID : INTEGER

              • attrName : STRING

              • callback : CallBackHandler

              Callback

              Async Callback Returning Parameters: BOOLEAN

                Returns

                Synchronous Return:

                • BOOLEAN

                Platforms

                • Android
                • Windows Mobile

                Method Access:

                • Class Method: This method can only be accessed via the API class object.
                  • EB.System.isBlobAttr(STRING partition, INTEGER sourceID, STRING attrName)

                openUrl(STRING url)

                Open the application associated with the URL. Behavior may be different on different platforms and depend on installed software. For example, open URL with http:// prefix will execute the Web Browser installed on system and open URL in executed browser. Note: Opening pdf files on Android devices is not supported. In android, "sms:","mailto:","tel:","http:","https:","file:" are supported. Hence it is recommended to use storage space or userFolder for the file uri.

                Parameters

                • url : STRING

                  URL as string.

                • callback : CallBackHandler

                Returns

                Synchronous Return:

                • Void

                Platforms

                • Android
                • Windows Mobile

                Method Access:

                • Class Method: This method can only be accessed via the API class object.
                  • EB.System.openUrl(STRING url)

                runApplication(STRING appName, STRING params, BOOLEAN blockingCall)

                Run an application.

                Parameters

                • appName : STRING

                  The name of the application on the device to run.

                • params : STRING Optional

                  Start parameters string. Executed Application can receive this string by getStartParams method. Parameter could be just value, or key-value pair separated by '=' sign. Please note that for each platform there are distinct ways to write several params at once. On Android parameters should be separated by an amperstand, on other platforms by a comma or a space.

                • blockingCall : BOOLEAN Optional

                  Not Implemented. False by default.

                • callback : CallBackHandler

                Returns

                Synchronous Return:

                • Void

                Platforms

                • Android
                • Windows Mobile

                Method Access:

                • Class Method: This method can only be accessed via the API class object.
                  • EB.System.runApplication(STRING appName, STRING params, BOOLEAN blockingCall)

                setNetworkStatusNotify(STRING url)

                Use Network.setStatusNotify: set network notification callback.

                Parameters

                • url : STRING

                  The url to the user-defined callback method.

                • callback : CallBackHandler

                Returns

                Synchronous Return:

                • Void

                Platforms

                • Android
                • Windows Mobile

                Method Access:

                • Class Method: This method can only be accessed via the API class object.
                  • EB.System.setNetworkStatusNotify(STRING url)

                setProperties(HASH propertyMap)

                This method will set the values of a list of properties for the API class. The propertyName must be a valid property for the class and must also not be read only.

                Parameters

                • propertyMap : HASH

                  Map of properties I want to set

                  • Object : STRING

                • callback : CallBackHandler

                Returns

                Synchronous Return:

                • Void

                Platforms

                • Android
                • Windows Mobile

                Method Access:

                • Class Method: This method can only be accessed via the API class object.
                  • EB.System.setProperties(HASH propertyMap)

                setProperty(STRING propertyName, STRING propertyValue)

                This method will set the value of a property for the API class. The propertyName must be a valid property for the class and must also not be read only.

                Parameters

                • propertyName : STRING

                  The one property name that I want to set

                • propertyValue : STRING

                  The one property value that I want to set

                • callback : CallBackHandler

                Returns

                Synchronous Return:

                • Void

                Platforms

                • Android
                • Windows Mobile

                Method Access:

                • Class Method: This method can only be accessed via the API class object.
                  • EB.System.setProperty(STRING propertyName, STRING propertyValue)

                setPushNotification(STRING url, STRING url_params, STRING push_client)

                Use Push.setPushNotification: Register push callback, the method to call upon receiving a push message.

                Parameters

                • url : STRING

                  URL of the callback method. If empty, unregisters rhoconnect-push.

                • url_params : STRING Optional

                  Parameters which will be added to callback URL.

                • push_client : STRING Optional

                  Name of a push service client. Current values can be 'rhoconnect_push' or 'gcm' or 'legacy' or empty. The call will be applied to every push client.

                • callback : CallBackHandler

                Returns

                Synchronous Return:

                • Void

                Platforms

                • Android
                • Windows Mobile

                Method Access:

                • Class Method: This method can only be accessed via the API class object.
                  • EB.System.setPushNotification(STRING url, STRING url_params, STRING push_client)

                setRegistrySetting(HASH propertyMap)

                Set a value in the device registry. Only applicable on Windows Mobile / Embedded Handheld and CE devices.

                Parameters

                • propertyMap : HASH

                  Map of properties associated with the registry key being set.

                  • hive : STRING

                    The hive name.

                    Possible Values :

                    Constant: EB.System.REGKEY_CLASSES_ROOT
                    String:HKCR
                    Set the property in the HKEY_CLASSES_ROOT hive.
                    Constant: EB.System.REGKEY_CURRENT_USER
                    String:HKCU
                    Set the property in the HKEY_CURRENT_USER hive.
                    Constant: EB.System.REGKEY_LOCAL_MACHINE
                    String:HKLM
                    Set the property in the HKEY_LOCAL_MACHINE hive.
                    Constant: EB.System.REGKEY_USERS
                    String:HKU
                    Set the property in the HKEY_USERS hive.
                  • type : STRING

                    The type.

                    Possible Values :

                    Constant: EB.System.REGTYPE_SZ
                    String:String
                    The type of the value being set is a string.
                    Constant: EB.System.REGTYPE_BINARY
                    String:Binary
                    The type of the value being set is a binary number.
                    Constant: EB.System.REGTYPE_DWORD
                    String:DWORD
                    The type of the value being set is a natural number (DWORD)
                    Constant: EB.System.REGTYPE_MULTI_SZ
                    String:MultiSZ
                    The type of the value being set is a multi line string. Separate your lines with \n (\\n in JavaScript)
                  • key : STRING

                    Full path of the key, including '\' separators as required. Remember to use '\\' in JavaScript to specify backslash.

                  • setting : STRING

                    The name of the registry setting to be set.

                  • value : STRING

                    The registry value to be set.

                  • persistent : BOOLEAN

                    Whether or not to create a corresponding merge file, setting to true will cause your value to persist across a device clean boot. A .reg file is written to the \Application folder on the device to persist the setting.

                • callback : CallBackHandler

                Callback

                Async Callback Returning Parameters: BOOLEAN

                  Returns

                  Synchronous Return:

                  • BOOLEAN : Whether or not the registry key was successfully set.

                  Platforms

                  • Windows Mobile

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.setRegistrySetting(HASH propertyMap)

                  setScreenRotationNotification(STRING url, STRING url_params)

                  Use ScreenOrientation.setScreenOrientationEvent: Notify (call a callback method) when the screen rotates.

                  Parameters

                  • url : STRING

                    URL of the callback method. If empty, unregisters notification callback.

                  • url_params : STRING Optional

                    Parameters which will be added to callback URL.

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Android
                  • Windows Mobile

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.setScreenRotationNotification(STRING url, STRING url_params)

                  setWindowFrame(INTEGER x, INTEGER y, INTEGER width, INTEGER height)

                  Change application window position and size.

                  Parameters

                  • x : INTEGER

                    Left corner of window.

                  • y : INTEGER

                    Top corner of window.

                  • width : INTEGER

                    Width of window.

                  • height : INTEGER

                    Height of window.

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.setWindowFrame(INTEGER x, INTEGER y, INTEGER width, INTEGER height)

                  setWindowPosition(INTEGER x, INTEGER y)

                  Change application window position.

                  Parameters

                  • x : INTEGER

                    Left corner of window.

                  • y : INTEGER

                    Top corner of window.

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.setWindowPosition(INTEGER x, INTEGER y)

                  setWindowSize(INTEGER width, INTEGER height)

                  Change application window size.

                  Parameters

                  • width : INTEGER

                    Width of the window.

                  • height : INTEGER

                    Width of the of window.

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.setWindowSize(INTEGER width, INTEGER height)

                  set_http_proxy_url(STRING proxyURI)

                  Use System.httpProxyURI property: To use client with the HTTP proxy.

                  Parameters

                  • proxyURI : STRING

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Windows Mobile
                  • Windows CE

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.set_http_proxy_url(STRING proxyURI)

                  set_locale(STRING locale_code, STRING country_code)

                  Use Application.setLocale method: set application specific locale.

                  Parameters

                  • locale_code : STRING

                  • country_code : STRING

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Android
                  • Windows Mobile

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.set_locale(STRING locale_code, STRING country_code)

                  set_sleeping(BOOLEAN enable)

                  Use System.screenSleeping property: enable / disable phone sleeping.

                  Parameters

                  • enable : BOOLEAN

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Android
                  • Windows Mobile

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.set_sleeping(BOOLEAN enable)

                  unset_http_proxy()

                  Use System.httpProxyURI property: Stop using HTTP proxy that was set by the command line, rhoconfig.txt or set_http_proxy_url.

                  Parameters

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Windows Mobile
                  • Windows CE

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.unset_http_proxy()

                  unzipFile(STRING localPathToZip, STRING password, STRING outputFileName)

                  Unzip file.

                  Parameters

                  • localPathToZip : STRING

                    The path to the file to be unzipped. Application should have write permissions to this folder.

                  • password : STRING Optional

                    Password for the zip.

                  • outputFileName : STRING Optional

                    Output file name. Used when decompressing gzip streams.

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Android
                  • Windows Mobile

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.unzipFile(STRING localPathToZip, STRING password, STRING outputFileName)

                  updateBlobAttribs(STRING partition, INTEGER sourceID)

                  Use Database.updateBlobAttribs: update model blob attributes list.

                  Parameters

                  • partition : STRING

                  • sourceID : INTEGER

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Android
                  • Windows Mobile

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.updateBlobAttribs(STRING partition, INTEGER sourceID)

                  zipFile(STRING localPathToZip, STRING localPathToFile, STRING password)

                  Zip one file. Zip archive must placed to the folder where application can write files.

                  Parameters

                  • localPathToZip : STRING

                    The path to the specified zip. Application should have write permissions to this folder.

                  • localPathToFile : STRING

                    The path to the file to be zipped.

                  • password : STRING Optional

                    Password for the zip.

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Android
                  • Windows Mobile

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.zipFile(STRING localPathToZip, STRING localPathToFile, STRING password)

                  zipFiles(STRING localPathToZip, STRING basePath, ARRAY filePathsToZip, STRING password)

                  Zip list of files.

                  Parameters

                  • localPathToZip : STRING

                    The path to the specified zip.

                  • basePath : STRING

                    Base path to the files to be zipped.

                  • filePathsToZip : ARRAY

                    List of file paths to be zipped.

                  • password : STRING Optional

                    Password for the zip.

                  • callback : CallBackHandler

                  Returns

                  Synchronous Return:

                  • Void

                  Platforms

                  • Android
                  • Windows Mobile

                  Method Access:

                  • Class Method: This method can only be accessed via the API class object.
                    • EB.System.zipFiles(STRING localPathToZip, STRING basePath, ARRAY filePathsToZip, STRING password)

                  Properties

                  country

                  Type

                  STRING Read Only

                  Description

                  Current device country code.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.country

                  Platforms

                  • Android
                  • Windows Mobile

                  deviceName

                  Type

                  STRING Read Only

                  Description

                  Name of device application running on. Examples: '9000' (BB), 'iPhone', 'dream' (Android). In Consumer Android device, name of the Industrial Design along with manufacturer name shall be shown.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.deviceName

                  Platforms

                  • Android
                  • Windows Mobile

                  deviceOwnerEmail

                  Type

                  STRING Read Only

                  Description

                  Primary email of phone owner. To access this property 'pim' capability must be enabled in your build.yml.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.deviceOwnerEmail

                  Platforms

                  • Android

                  deviceOwnerName

                  Type

                  STRING Read Only

                  Description

                  Name(account name) of phone owner. To access this property 'pim' capability must be enabled in your build.yml.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.deviceOwnerName

                  Platforms

                  • Android

                  devicePushId

                  Type

                  STRING Read Only

                  Description

                  Replaces:deviceId Push notifications device ID which may be used to receive push messages.To get this ID , Push service should be configured on the device. Please refer to Push documentation.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.devicePushId

                  Platforms

                  • Android
                  • Windows Mobile

                  freeServerPort

                  Type

                  INTEGER Read Only

                  Description

                  Get free local server port, available for binding.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.freeServerPort

                  Platforms

                  • Android
                  • Windows Mobile

                  hasCalendar

                  Type

                  BOOLEAN Read Only

                  Description

                  Returns true if calendar support is available.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.hasCalendar

                  Platforms

                  • Android
                  • Windows Mobile

                  hasCamera

                  Type

                  BOOLEAN Read Only

                  Description

                  Returns true if there is a camera available on the device.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.hasCamera

                  Platforms

                  • Android
                  • Windows Mobile
                  • Windows CE

                  hasCellNetwork

                  Type

                  BOOLEAN Read Only

                  Description

                  Deprecated Use Network.hasCellNetwork to tell if device is connected to the cell network.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.hasCellNetwork

                  Platforms

                  • Android
                  • Windows Mobile

                  hasNetwork

                  Type

                  BOOLEAN Read Only

                  Description

                  Deprecated Use Network.hasNetwork to tell if the device is connected to the network.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.hasNetwork

                  Platforms

                  • Android
                  • Windows Mobile

                  hasSqlite

                  Type

                  BOOLEAN Read Only

                  Description

                  Deprecated Returns true if the device has sqlite capabilities (previously only BlackBerry did not support this).

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.hasSqlite

                  Platforms

                  • Android
                  • Windows Mobile

                  hasTouchscreen

                  Type

                  BOOLEAN Read Only

                  Description

                  Returns true if the device has touch screen capabilities. For Win32 desktop builds this API will return whether mouse support is available.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.hasTouchscreen

                  Platforms

                  • Android
                  • Windows Mobile

                  hasWifiNetwork

                  Type

                  BOOLEAN Read Only

                  Description

                  Deprecated Use Network.hasWifiNetwork to tell if the device is connected to the wifi network.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.hasWifiNetwork

                  Platforms

                  • Android
                  • Windows Mobile

                  httpProxyURI

                  Type

                  STRING

                  Description

                  Replaces:http_proxy_url Set HTTP proxy parameters for using the Network module. Example: 'user:password@url:port'. Supports basic authentication only. Do not include 'http://'. Setting this property overrides http_proxy_uri, http_proxy_host, http_proxy_port, http_proxy_user and http_proxy_password. Proxy settings for Windows Mobile/CE with Zebra WebKit should be configured in the config.xml file.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.httpProxyURI

                  Platforms

                  • Android
                  • Windows Mobile

                  isEmulator

                  Type

                  BOOLEAN Read Only

                  Description

                  Returns true if the application is running on a platform emulator.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.isEmulator

                  Platforms

                  • Android
                  • Windows Mobile

                  isMotorolaDevice

                  Type

                  BOOLEAN Read Only

                  Description

                  Deprecated Returns true if the device supports Motorola device capabilities. APIs will indicate if the property or method is available on Motorola devices only. You can use this property to help your application decide when to take advantage of advanced Motorola capabilities. This property has been deprecated. It is recommended to use 'isSymbolDevice' property.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.isMotorolaDevice

                  Platforms

                  • Android
                  • Windows Mobile

                  isSymbolDevice

                  Type

                  BOOLEAN Read Only

                  Description

                  Returns true if the device supports Symbol device capabilities. APIs will indicate if the property or method is available on Symbol devices only. You can use this property to help your application decide when to take advantage of advanced Symbol capabilities.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.isSymbolDevice

                  Platforms

                  • Android
                  • Windows Mobile

                  keyboardState

                  Type

                  STRING

                  Description

                  For Windows Mobile and Windows CE the keyboard can be manually shown or hidden as required. All other platforms only support 'automatic'. The default state for Windows Mobile and Windows CE is manual, for all other platforms it is automatic.

                  Params

                  Default: See Description

                  Values

                  Possible Values (STRING):

                  • Constant: EB.System.KEYBOARD_SHOWN - String: shown Shows the on screen keyboard, after setting the keyboard to shown or hidden it will no longer appear / disappear automatically until you set this property to automatic.
                  • Constant: EB.System.KEYBOARD_HIDDEN - String: hidden Hides the on screen keyboard, after setting the keyboard to shown or hidden it will no longer appear / disappear automatically until you set this property to automatic. This is most useful if your device has a hardware keyboard or you are scanning / capturing data to an input field.
                  • Constant: EB.System.KEYBOARD_AUTOMATIC - String: automatic Automatically shows or hides the keyboard as needed by the application.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.keyboardState

                  Platforms

                  • Windows Mobile
                  • Zebra Devices Only

                  localServerPort

                  Type

                  INTEGER Read Only

                  Description

                  Port of the local (embedded) HTTP server. This parameter is mainly for debug purposes. If not specified, the platform will detect a free port on the device and use that one.

                  Params

                  Default: 8080

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.localServerPort

                  Platforms

                  • Android
                  • Windows Mobile

                  locale

                  Type

                  STRING Read Only

                  Description

                  Current device locale Like 'en', 'ru' etc.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.locale

                  Platforms

                  • Android
                  • Windows Mobile

                  lockWindowSize

                  Type

                  BOOLEAN

                  Description

                  Lock / unlock the window size change by the user. When running on RhoSimulator, this method is supported only for Windows OS.

                  Params

                  Default: false

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.lockWindowSize

                  oemInfo

                  Type

                  STRING Read Only

                  Description

                  The OEM Information string for the terminal.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.oemInfo

                  Platforms

                  • Android
                  • Windows Mobile
                  • Windows CE
                  • Zebra Devices Only

                  osVersion

                  Type

                  STRING Read Only

                  Description

                  Version OS of device. Examples: '4.1' (Android).

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.osVersion

                  Platforms

                  • Android
                  • Windows Mobile

                  phoneId

                  Type

                  STRING Read Only

                  Description

                  Hardware based ID. It depends on capabilities configured for an application and has to remain same even across application uninstall/install.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.phoneId

                  Platforms

                  • Android
                  • Windows Mobile
                  • Windows CE

                  platform

                  Type

                  STRING Read Only

                  Description

                  Platform where application is running.

                  Values

                  Possible Values (STRING):

                  • Constant: EB.System.PLATFORM_WM_CE - String: WINDOWS
                  • Constant: EB.System.PLATFORM_ANDROID - String: ANDROID
                  • Constant: EB.System.PLATFORM_WINDOWS_DESKTOP - String: WINDOWS_DESKTOP

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.platform

                  Platforms

                  • Android
                  • Windows Mobile
                  • Windows CE

                  ppiX

                  Type

                  INTEGER Read Only

                  Description

                  Horizontal PPI (Pixels Per Inch).

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.ppiX

                  Platforms

                  • Android
                  • Windows Mobile

                  ppiY

                  Type

                  INTEGER Read Only

                  Description

                  Vertical PPI (Pixels Per Inch).

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.ppiY

                  Platforms

                  • Android
                  • Windows Mobile

                  realScreenHeight

                  Type

                  INTEGER Read Only

                  Description

                  Screen height in real pixels.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.realScreenHeight

                  Platforms

                  • Android
                  • Windows Mobile

                  realScreenWidth

                  Type

                  INTEGER Read Only

                  Description

                  Screen width in real pixels.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.realScreenWidth

                  Platforms

                  • Android
                  • Windows Mobile

                  screenAutoRotate

                  Type

                  BOOLEAN

                  Description

                  Screen auto rotate.

                  Params

                  Default: true

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.screenAutoRotate

                  Platforms

                  • Android

                  screenHeight

                  Type

                  INTEGER Read Only

                  Description

                  Screen height in logical pixels (used for set coordinates).

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.screenHeight

                  Platforms

                  • Android
                  • Windows Mobile

                  screenOrientation

                  Type

                  STRING Read Only

                  Description

                  Current screen orientation.

                  Values

                  Possible Values (STRING):

                  • Constant: EB.System.SCREEN_PORTRAIT - String: portrait The return value if the screen is in portrait mode.
                  • Constant: EB.System.SCREEN_LANDSCAPE - String: landscape The return value if the screen is in landscape mode.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.screenOrientation

                  Platforms

                  • Android
                  • Windows Mobile

                  screenSleeping

                  Type

                  BOOLEAN

                  Description

                  If true, then screen will go to sleep by system inactivity timeout. If false then screen never go to sleep while application is in foreground.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.screenSleeping

                  Platforms

                  • Android
                  • Windows Mobile

                  screenWidth

                  Type

                  INTEGER Read Only

                  Description

                  Screen width in logical pixels (used for set coordinates).

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.screenWidth

                  Platforms

                  • Android
                  • Windows Mobile

                  uuid

                  Type

                  STRING Read Only

                  Description

                  The Unique Unit IDentifier for the terminal.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.uuid

                  Platforms

                  • Android
                  • Windows Mobile
                  • Windows CE
                  • Zebra Devices Only

                  webviewFramework

                  Type

                  STRING Read Only

                  Description

                  Browser framework identity string.

                  Access

                  • Class: This property can only be accessed via the API class object.
                    • EB.System.webviewFramework

                  Platforms

                  • Android
                  • Windows Mobile