RoamAbout Developer

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.

Create Overlay

Sample:

RoamAbout.createOverlay(callback, context, width, height, query) Samples

Request Parameters:

Name	Optional/Required	Description
callback	Required	The function to call after processing the request with the status and result data.
context	Optional	The context text to pass for your reference.
width	Required	The width of the overlay to be created.
height	Required	The height of the overlay to be created
query	Required	To pass the parameters to the callback url in a query string.

Callback function parameters:

Name	Description
status	The status of the action performed, It would be 0 for successful response.
data	The response text to the callback function. For this API it will contain overlayId in the data field.
context	The context parameter that you passed in the request.

Delete Overlay

Sample:

RoamAbout.destroyOverlay(callback, context, overlayId) Samples

Request Parameters:

Name	Optional/Required	Description
callback	Required	The function to call after processing the request with the status and result data.
context	Optional	The context text to pass for your reference.
overlayId	Required	The reference for the overlay

Callback function parameters:

Name	Description
status	The status of the action performed, It would be 0 for successful response.
data	The response text to the callback function. For this API it will contain overlayId in the data field.
context	The context parameter that you passed in the request.