API Overview
 

This section contains the list of available APIs in the RoamAbout. Here you can see the parameters, callback function for each of the APIs.

 
 
Session storage
 

Session storage is used to store and retrieve widgelet specific information in RoamAbout. It can be used to share information across instances of the widgelet (one for each tab) in the same browser session or to make the information persistence across browser sessions. It has two API methods namely setAttribute() and getAttribute().

 
Service callback
 

Service callback is used to send an http request back to your application servers from the widgelet. This can be used to get data from the server side of the widgelet without having to create an overlay. This method is asynchronous.The widgelet callback URL is invoked with the specified Query String and the response is provided back to the widgelet in the callback function.

 
Overlay management
 

The main functionality of overlay management is to create / destroy the app overlays on the web page. The callback function is invoked when the operation completes.

 
Browser context
 

Browser context APIs are used to get the browser page information. Currently, the location, selection and title of the document are available through the APIs.

 
Communication
 

These APIs allow applications to voice or text chat enable their applications using Vysr's voice and text infrastructure. Both one-one and group communications are supported. Chatrooms can also be embedded in the application with a simple call. This is currently in limited beta tests and will be available shortly.

 
Social networks
 

These APIs allow posting of content to one's profile and sharing of content amongst friends in the supported social networks. This is currently in limited beta tests and will be available shortly.