API Reference:Main

From Spot Specific Documentation

Overview

This area outlines the services and methods available to Spot Specific users to extend Standard widget behaviours.

How the API reference is organised

In general, the API documentation is organised according to the class which a given method belongs to.

You can browse the API documentation using the list box at the right of this page.

API calls and Standard Features

To increase application running speed, the Spot Specific API is loaded selectively as needed. This is accomplished through the use of Standard Features, which contain elements of API functionality. The table below outlines the Standard Features required for particular API classes/functions.

Note that Widgets always load any Standard Features they require to operate automatically. Manual loading is only required when working with custom code.

Please note that this table is a work in progress, and will be updated frequently.

API class/function	Required Standard Feature	Notes
_ssgeolocation	Geolocation	This class provides access to device location data.
_SS_SpotAudioPlayer	SpotEngine - Foreground Audio Player	Builds an audio player with a customised interface made up of DOM elements.
_SSXHR()	XHR	Works identically to the JavaScript XMLHttpRequest() object. See class documentation.
NativeUI()	Core UI	Required for all classes and methods in the NativeUI namespace.
rss()	RSS	Required for parsing and manipulating RSS feeds.
store	Store	Key-value storage, similar to HTML Local Storage.