Show:
Extends EndPoint

Provides access to information about the currently active set of key ranges

Access this object via the keyRanges property.

Table of Contents

Methods

close ()

Inherited from EndPoint: EndPoint.js:55

Closes the end point and stops listening for events.

This method no longer needs to be explicitly called as end points are now automatically closed when the last event listener is removed.

open ()

Inherited from EndPoint: EndPoint.js:35

Opens this end point and starts listening for events.

This method no longer needs to be explicitly called as end points are now automatically opened when the first event listener is attached.

Use this method to keep the end point open even when no event listeners are attached.

untilOpen () Promise

Inherited from EndPoint: EndPoint.js:137

Returns a promise that will be resolved when this end point is opened

Returns:

Promise

Example:

let C = new CantabileApi();
   C.application.open();
await C.application.untilOpen();

Properties

items

KeyRange[]

Defined in KeyRanges.js:36

An array of key ranges

Events

changed

Defined in KeyRanges.js:23

Fired when the active set of key ranges has changed