Intel XDK Name Space API Plugin Details for Cordova Build Containers

The title of each API section in this document contains a link that will take you directly to a more detailed intel.xdk API documentation page for that specific plugin. The Intel XDK plugins described on this page represent the intel.xdk APIs that are present when using the Cordova build system. For detailed documentation regarding the "legacy" build system, please see the Intel XDK JavaScript Bridge API documentation page.

• intel.xdk.base DEPRECATED
• intel.xdk.accelerometer DEPRECATED
• intel.xdk.audio
• intel.xdk.cache
• intel.xdk.camera
• intel.xdk.contacts
• intel.xdk.device
• intel.xdk.display DEPRECATED
• intel.xdk.facebook DEPRECATED
• intel.xdk.file
• intel.xdk.geolocation DEPRECATED
• intel.xdk.notification DEPRECATED
• intel.xdk.player

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 DEPRECATED

This Intel XDK Cordova plugin and API has been deprecated. Please use the equivalent standard Cordova "deviceready" event and Cordova device plugin instead. NOTE: the Cordova "deviceready" event is built into the Cordova framework and does not require any plugins to be detected.

See the the standard Cordova splashscreen plugin for an alternative to the intel.xdk splashscreen functions.

Additional documentation will be provided, at a later date, for alternatives to the platform detection properties and the web root function.

intel.xdk.accelerometer DEPRECATED

This Intel XDK Cordova plugin and API has been deprecated. Please use the equivalent standard Cordova accelerometer plugin instead.

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 DEPRECATED

This Intel XDK Cordova plugin and API has been deprecated. Please use the meta viewport tag.

The following articles are worth reviewing:

• Don't Forget the Viewport Meta Tag
• Understanding The Viewport Meta Tag
• github.com/andreasbovens/understanding-viewport
• W3C Viewport META Element
• An Introduction to Meta Viewport and @viewport
• QuirksMode.org: The Meta Viewport Tag

Additional alternatives will be provided at a later date.

intel.xdk.facebook DEPRECATED

This Intel XDK Cordova plugin and API has been deprecated. A suggested alternative Cordova plugin for use on Android and iOS platforms is available as a third-party plugin. Coverage for all platforms is available using this JavaScript micro library (this is not a plugin). In addition, a general-purpose OAuth2 JavaScript library (no plugin required) named "HelloJS" can be used to log into Facebook (as well as a variety of other services).

intel.xdk.file

For uploading files to an appropriately configured server.

intel.xdk.geolocation DEPRECATED

This Intel XDK Cordova plugin and API has been deprecated. Please use the equivalent standard Cordova geolocation plugin instead.

intel.xdk.notification DEPRECATED

This Intel XDK Cordova plugin and API has been deprecated. Please use the equivalent standard Cordova notification plugins instead. NOTE: there are two notification plugins, named "Dialogs" and "Vibration."

intel.xdk.player

For playing audio and video media files and streams.