Warning Unreleased Docs! - You may be viewing documentation that reflects an upcoming release and the functionality described may not be in the current version you are using. Change the version above to the most recent version.

RhoMobile API Summary

Below is a list of the new common APIs for RhoMobile Suite 5.3, which are recommended for all new projects. If you’re moving a 2.x app to 5.x, please consult the 2.x migration guide.

5.3 APIs

- API/platform is supported; no license required

- API/platform is supported; paid subscription required for production use

- API is available only on Symbol devices

LANGUAGES PLATFORMS
Class
Addressbar *
Alarm *
Application
AudioCapture
Backlight *
Barcode
Battery
BluetoothManager *
BluetoothSession *
Camera
CardReader
Comm
Config
Database
Device
Document Capture (BETA)
Geolocation
Gesture *
Hourglass *
Intent
KeyCapture
Keylight *
KeyState
Log
Mapview *
Mediaplayer
Memory *
NativeMenubar
NativeTabbar
NativeToolbar
Navbar
NdefMessage *
NdefRecord *
Network
NFC - Adapter (BETA)
NFC - Message (BETA)
NFC - Record (BETA)
NFC - Tag (BETA)
NFCManager *
NFCTag *
NFCTagTechnology_IsoDep *
NFCTagTechnology_MifareClassic *
NFCTagTechnology_MifareUltralight *
NFCTagTechnology_Ndef *
NFCTagTechnology_NdefFormatable *
NFCTagTechnology_NfcA *
NFCTagTechnology_NfcB *
NFCTagTechnology_NfcF *
NFCTagTechnology_NfcV *
NFCTagTechnology *
Notification
ORM & ORMModel
Printer
Printer Zebra
Push
Reboot *
Registry *
RFID *
RhoConnectClient
RhoContact *
RhoController *
RhoError *
RhoEvent *
RhoFile
RhomSource *
RhoProfiler *
RhoUtils *
ScreenOrientation
Sensor
SignalIndicators
Signature
SignatureCapture (inline) *
SmartCradle
Stylus *
System
SystemTime *
Timer
VideoCapture *
Volume *
Wake *
Webview

*These API classes are implemented in RhoMobile Suite 2.2 but are not yet included in the new Common API class set for RhoMobile Suite 5.3. They use the older 2.2 format and support Ruby only except as noted.

When using 2.2 APIs in RhoMobile 5.3, the 2.2 API compatibility matrix applies.

Licensing

APIs in the table above that are indicated with the icon require silver- or gold-level licensing for use in production. For details, please refer to the Licensing Guide.

JavaScript APIs

To use the JavaScript APIs in RhoElements 2.2, you must add the public/js/rho_javascript_api.js file to the .html, .erb, or .js file that’s calling the JavaScript method. This file is created at build time as part of the application package and can coexist with RhoMobile 5.3 JavaScript API file rhoapi-modules.js. However, it has been altered from the version built using 2.2, and must be regenerated to allow it to properly coexist with other files of your 5.3 app.

JavaScript ORM

If you’re using the JavaScript ORM API, include this line in any files that will be calling it:

<script type="text/javascript" charset="utf-8" src="/public/api/rhoapi-modules-ORM.js"></script>

Using older JavaScript APIs

In the event that a pre-4.0 JavaScript API is required to work with one of the new Common JavaScript APIs, it is possible to create a compatibility layer this way:

<!-- required for pre-4.0 JS API: -->
<script type="text/javascript" src="/public/jquery/jquery-1.6.4.min.js"></script>
<script type="text/javascript" src="/public/jquery/jquery.json-2.3.min.js"></script>

<!-- pre-4.0 JS API: -->
<script type="text/javascript" src="/public/js/rho_javascript_api.js"></script>

<!-- compatibility layer: -->
<script type="text/javascript" src="/public/js/rho_common_api_noconflict.js"></script>

<!-- new Common JS API: -->
<script type="text/javascript" charset="utf-8" src="/public/api/rhoapi-modules.js"></script>
Important: Modules must be loaded in this order!

Future Common APIs

Toward the goal of supplying a Common API format for both JavaScript and Ruby, the following API classes will be included in future versions of RhoMobile Suite 5.x.

RhoElements 2.2 APIs

The 2.2 RhoElement APIs are supported only on Zebra WebKit, which is still available on Windows Mobile/CE and Android platforms. The APIs for 5.x support the stock Android WebKit by default.

Rhodes 2.2 APIs

2.2 Rhodes APIs that were not replaced by an equivalent RhoMobile 5.3 API (ex: Camera) are supported on all platforms that were supported previously. Ruby APIs will behave exactly as they did before. Note that some of the Rhodes 2.2 APIs provided JavaScript support but used a different version of the RhoMobile JavaScript API library: rho_javascript_api.js

To generate this file you must enable JavaScript by putting rho-javascript into extensions in your build.yml.

extensions: ["rho-javascript"]
Back to Top