Intel XDK Name Space API Plugin Details for Cordova Build Containers

The title of each API section below contains a link that will take you directly to the appropriate section of the intel.xdk API documentation.

Note that the APIs listed below augment the standard Cordova APIs, both APIs can and should be used in your application. In some cases there is overlap between the Cordova APIs and the intel.xdk APIs; in that case, we recommend you use the Cordova API first and then use the intel.xdk API when the Cordova API either does not provide the desired functionality or provides inadequate functionality. Do not mix overlapping APIs within your application; in other words, use only the Cordova accelerometer API or the intel.xdk accelerometer API in your app, do not use both in the same app. This overlap between two similar device APIs exists for historical reasons and is not recommended for normal use.

APIs marked as "pending" in the notes section are still under development or have not been fully tested. APIs marked as "removed" are not present in the Cordova build system but may still exist in the standard "Intel XDK" build containers and may also be supported by the Emulator tab within the Intel XDK (see this list of APIs that are not supported by the Emulator).

To include these APIs as part of your application you must include a reference to "cordova.js" in your index.html file. In your Cordova build configuration file you also need to include a reference to each plugin required by the API(s) you are using by "value" and "name" where "value" is the title of each API section below (e.g., intel.xdk.accelerometer) and "name" is the last segment of that title (e.g., accelerometer), unless indicated otherwise. See Using the Intel XDK "Cordova for *" Build Option for detailed information.

intel.xdk.base

The properties in this plugin are useful for writing device-dependent code fragments. In addition to the properties provided here, there are two methods and one event included with this plugin, they are the "bare minimum" required to get your Cordova container up and running quickly. Note that the methods and events included in this plugin have equivalents in the core Cordova plugins, which are recommended for new applications. The methods and events are provided here to support existing XDK applications and to minimize application permission requirements (this plugin requires no special permission).

intel.xdk.accelerometer

For reading the device accelerometer.

intel.xdk.audio

For playing and recording audio elements.

intel.xdk.cache

For persistent caching of data between application sessions.

intel.xdk.camera

For capturing images with the camera and accessing those images.

intel.xdk.contacts

For access to the on-device contacts database.

intel.xdk.device

Configure the device and/or retrieve information pertinent to the device.

intel.xdk.display

For controlling aspects of the device's display.

intel.xdk.facebook

For access to an end-user's Facebook account.

intel.xdk.file

For uploading files to an appropriately configured server.

intel.xdk.geolocation

For access to the device location tracking hardware.

intel.xdk.multitouch

To enable device multi-touch features on Android devices.

intel.xdk.notification

Provides device-specific alerts.

intel.xdk.player

For playing audio and video media files and streams.