This article details the properties that are passed as parameters to the window.LearnosityAuthorAide.init() method to initialize Author Aide API.

This method is the starting point to initializing and rendering Author Aide API, and as you can see in the example below, takes two key parameters:

• Initialization object
• Callbacks object

The Initialization object is mandatory. Further details on getting started and initializing Author Aide API can also be found in the Getting Started guide.

Example

var initializationOptions = {
    // example parameters
};

var callbacks = {
    readyListener: function () {
        console.log("Learnosity Author Aide API is ready");
    }
};

let authorAideApp = window.LearnosityAuthorAide.init(initializationOptions, callbacks);
    

Initialization Object

The Initialization object is a JSON object which is passed as the first parameter into the window.LearnosityAuthorAide.init() method. It includes all the information needed to initialize the API.

It contains the following two top-level properties:

• Security object
• Request object

Security Object

The Security object is a property generated by the Learnosity serverside SDKs to ensure that any of the APIs are only initialized from a secured, allowed source, using your consumer key and secret.

This is handled by our SDKs in:

• .NET
• Java
• Node.JS
• PHP
• Python
• Ruby

For other languages, please see our Security & Authentication page on how to sign your requests.

Request Object

The Request object contains all of the configuration properties for user & session identification and user interface look and feel.

See the Request Object article for more information.

Callbacks

The Callbacks object contains optional callback functions that allow detection of the ready status of an Author Aide API instance and any errors encountered.

See the Callbacks article for more information.