Warning Older Docs! - You are viewing documentation for a previous released version of RhoMobile Suite.

Wake Module

The Wake Module is used to keep the display and wifi ON as long as RhoElements is active

Syntax

wake (Module) <META> Syntax

<META HTTP-Equiv="wake" content="[parameter]">

Wake JavaScript Object Syntax:
By default the JavaScript Object 'wake' will exist on the current page and can be used to interact directly with the wake.
To Set wake parameters via JavaScript use the following syntax: wake.parameter = 'value'; remembering to enclose your value in quotes where appropriate.

e.g. wake.wakeLock = 'value';
To set multiple EMML parameters / events on a single line use the following syntax: wake.setEMML("[Your EMML Tags]");

e.g. wake.setEMML("wakeLock:value");
Wake Ruby Object Syntax:
By default the Ruby Object 'Wake' will exist on the current page and can be used to interact directly with the Wake. All Methods, Parameters and Events are the same as JavaScript, however, notice 'Wake' needs to start with an uppercase letter. Another difference in Ruby is that methods do not end in '()'
To Set Wake parameters via Ruby use the following syntax: Wake.parameter = 'value' remembering to enclose your value in quotes where appropriate.

e.g. Wake.wakeLock = 'value'

Parameters

Items listed in this section indicate parameters, or attributes which can be set.

Name Possible Values Description Default Value
wakeLock:[Value] Enabled, disabled Enables / disables the screen Disabled
wifiLock:[Value] Enabled, disabled Enables / disables the network Disabled

Remarks

wake Method

Please note that enabling locks override the system values and consume more battery power.

Requirements

RhoElements Version 2.2 or above
Supported Devices Enterprise Tablet only
Minimum Requirements None
Persistence Persistent - Changes to this module will persist when navigating to a new page.

HTML/JavaScript Examples

The following keeps the device on and doesn’t go to standby

<META HTTP-Equiv="wake" Content="wakeLock:Enabled;wifiLock:Enabled">
Back to Top