WebPlayer

WebPlayer

Instances of this class are returned from Instance#webplayer. They should not be created using the constructor.

Members

info

Source:

Returns information about the Web Player session

Example
let sessionInfo = webPlayerInst.info

Methods

(async, static) sessions(project) → {Promise.<Array.<WebPlayerSession>>}

Source:

Lists all active Web Player sessions

Example
const sessions = webPlayerInst.sessions()
session.forEach(session => console.log(`${session.userId} session expires at ${session.expiration}`))
Parameters:
Name Type Description
project object
Returns:
Type
Promise.<Array.<WebPlayerSession>>

(async) destroy(session) → {Promise.<Response>}

Source:

Destroy the Web Player session

Example
await webPlayerInst.destroySession()
Parameters:
Name Type Description
session string
Returns:
Type
Promise.<Response>

(async) refreshSession() → {Promise.<WebPlayerSession>}

Source:

Updates and returns information about the Web Player session

Example
let sessionInfo = webPlayerInst.refreshSession()
Returns:
Type
Promise.<WebPlayerSession>