WebPlayer

WebPlayer

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

Members

info

Description:

  • Returns information about the Web Player session

Source:

Returns information about the Web Player session

Example
let sessionInfo = webPlayerInst.info

Methods

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

Description:

  • Destroy the Web Player session

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

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

Description:

  • Updates and returns information about the Web Player session

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

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

Description:

  • Lists all active Web Player sessions

Source:
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>>