BIC-jQM: publicly-accessible values

Note: this document assumes you are familiar with JSDoc 3 namepaths.

BIC-jQM creates and maintains state across JavaScript objects and values. If you know where to look, you may access this state from your own custom JavaScript.

We use Backbone.JS to manage state with conventional Object-Oriented patterns. Thus, you may interrogate and manipulate the BIC-jQM state by using the Backbone APIs.

Backbone.Model

You may use the Backbone.Model and the Backbone.Events APIs on the objects listed in this section.

BMP.BIC

The primary access point for much of the BIC-jQM state

require(['bic'], function (bic) {
  bic === window.BMP.BIC; // true;
});

.version

• @type {String}

A handy reference to the current version of BIC-jQM

require(['bic'], function (bic) {
  bic.version; // "x.y.z"
});

.id

• @type {String}

A handy reference to the name of the answerSpace

require(['bic'], function (bic) {
  bic.id; // "name"
});

(attribute) loginStatus

• either a {Boolean} false, or an {Object} containing current user authentication information

require(['bic'], function (bic) {
  bic.get('loginStatus'); // false or { ...}
});

.collections()

• @returns {Promise} resolved when collections are safe to use

.whenPopulated()

• @returns {Promise} resolved when answerSpace configuration is available

Backbone.Collection

You may use the Backbone.Collection and the Backbone.Events APIs on the objects listed in this section.

collections on BMP.BIC

See the example below for the list of BMP.BIC collections:

require(['bic'], function (bic) {
  bic.collections().then(function () {
    bic.interactions;
    bic.datasuitcases;
    bic.forms; // collection of form definitions
    bic.formRecords; // populated when listing server-side records
    bic.pending; // populated when saving client-side drafts / submissions
    bic.stars; // populated when using legacy stars functionality
  });
});

Some collections are initially empty, so you may wish to use .whenPopulated() if your code needs to run after the collections contain useful answerSpace configuration data:

require(['bic'], function (bic) {
  bic.whenPopulated().then(function () {
    bic.interactions.length > 0; // true, the answerSpace itself counts as one
    bic.datasuitcases.length > 0; // only true if you have public datasuitcases
  });
});