Supervisor

var supervisor = new Supervisor({ url: 'https://your-proctoring-server' });

Members

(readonly) el

Description:

• Get the current HTML element.

(static, readonly) VERSION

Description:

• Get the SDK version.

Methods

(async) check(optionsopt)

Description:

• Equipment check.

Example

// check all equipment
supervisor.check();
// check only the camera
supervisor.check({ camera: true });
// check the camera and microphone
supervisor.check({ camera: true, microphone: true });

Parameters:

(async) close()

Description:

• Close the session without stopping or logging out. It will be possible to continue the session by calling the start again.

Example

supervisor.close();

(async) init(optionsopt) → {Object}

Description:

• Initialize the session from specific payload.

Example

supervisor.init({
  // set your provider name
  provider: 'jwt',
  // get JWT string from your server
  token: fetch('/api/token').then(function (response) {
    if (response.ok) return response.text();
    else throw Error('Failed to get JWT');
  })
});

Parameters:

Returns:

Type

Object

(async) logout(optionsopt)

Description:

• Log out from the session.

Example

supervisor.logout({ redirect: true });

Parameters:

lookup(…argsopt) → {Object}

Description:

• Lookup the session fields.

Example

supervisor.lookup('identifier', 'username', 'subject', 'duration');

Parameters:

Returns:

Type

Object

off(event, handler)

Description:

• Remove the event handler.

Example

// unsubscribe from a single event
supervisor.off('stop', handler);
// unsubscribe from multiple events
supervisor.off(['stop', 'fail'], handler);

Parameters:

on(event, handler)

Description:

• Add an event handler.

Example

// event handler
var handler = function() {
  supervisor.logout({ redirect: true });
};
// subscribe to a single event
supervisor.on('stop', handler);
// subscribe to multiple events
supervisor.on(['stop', 'fail'], handler);

Parameters:

once(event, handler)

Description:

• Add an event handler for emitted once.

Example

// event handler
var handler = function() {
  // event occurred
};
// subscribe to an event
supervisor.once('start', handler);

Parameters:

(async) profile(options)

Description:

• Update current user profile data.

Example

// change user's full name and UI language
supervisor.profile({ nickname: 'John Doe', lang: 'en' });
// upload user's face photo
supervisor.profile({ face: '/path/to/face.jpg' });
// or the same using fetch()
supervisor.profile({ face: fetch('/path/to/face.jpg').then(res => res.blob()) });

Parameters:

(async) start(optionsopt) → {Object}

Description:

• Initialize and start or resume the session.

Example

// start the already initialized session or self-registration mode
supervisor.start();
// initialize and start the session with parameters
supervisor.start({ provider: 'jwt', token: '...' });

Parameters:

Fires:

• Supervisor#event:start
• Supervisor#event:fail

Returns:

Type

Object

(async) stop()

Description:

• Stop the session and log out.

Example

supervisor.stop();

Fires:

• Supervisor#event:stop
• Supervisor#event:fail

(async) sync(optionsopt) → {Object}

Description:

• Synchronize the session state by token.

Example

supervisor.sync({ token: 'SESSION_TOKEN' });

Parameters:

Returns:

Type

Object

Type Definitions

Metrics

Description:

• Schema of metrics. Each metric is in the range from 0 to 100.

Properties:

Type:

• Object

Payload

Description:

• Schema of payload.

Properties:

Type:

• Object

eventHandler(dataopt)

Description:

• Callback function for message event.

Parameters:

Events

chat

Description:

• Text of the sent or received message.

Properties:

face

Description:

• A photo of the face was taken. The image is saved in JPEG format.

Properties:

fail

Description:

• Critical error during the session initializing, starting, or stopping.

Properties:

load

Description:

• The content within the IFRAME has been loaded.

Properties:

metrics

Description:

• The metrics of user behavior are obtained.

Properties:

start

Description:

• The session has been started.

stop

Description:

• The session has been stopped.