JavaScript API functions

Switch to

JavaScript API version 1

Changelog

Initial version of the JavaScript API

Usage

The methods listed below are all available on the window.ShowpadLib object after page load. Simply call the desired method with the correct parameters.

If the onShowpadLibLoaded method is defined on the window object, this method will be called when ShowpadLib is created and ready to be used.

Have a look at the examples to get some more context.

Methods

All methods returning a boolean (all methods except for getUserInfo) will return true when the call was executed successfully and return false when something went wrong. The method returns false when a required parameter was not set or when the method was called again before the previous method was completed.

getUserInfo

Returns the information of the active user

addToShowcase

Deprecated since version 2

removeFromShowcase

Deprecated since version 2