Home Manual Reference Source
public class | source

Weak

Extends:

src/mapping/core.js~Service → Weak

User API for weak devices control

User API for control and release of weakly authenticated user sessions.

Static Member Summary

Static Public Members
public static get

Get default deployment id associated to Weak service

Method Summary

Public Methods
public

control(objectPattern: {"publicToken": *, "fullRights": *}): *

Controls a session

public

getToken(): *

Returns the current token

public

release(objectPattern: {"publicToken": *, "fullRights": *}): *

Releases a session

Static Public Members

public static get DEFAULT_DEPLOYMENT_ID: string: string source

Get default deployment id associated to Weak service

Return:

string

Public Methods

public control(objectPattern: {"publicToken": *, "fullRights": *}): * source

Controls a session

Takes control of a weak user session, identified by the given public token. The public token has been previously made available by the controlled device, for example by displaying a QRCode. Upon control notification, the client SDK of the controlled session is expected to re-handshake.

Params:

NameTypeAttributeDescription
objectPattern {"publicToken": *, "fullRights": *}
  • default: {"publicToken":null,"fullRights":null}

Return:

*

public getToken(): * source

Returns the current token

Returns your current session's private token. The token field may be null, if you did not log in with this authentication. The token can be used to log in as the same weak user another time.

Return:

*

public release(objectPattern: {"publicToken": *, "fullRights": *}): * source

Releases a session

Releases control of a weak user session, identified by the given public token. The weak user session must have been previously controlled by a call to 'control'.

Params:

NameTypeAttributeDescription
objectPattern {"publicToken": *, "fullRights": *}
  • default: {"publicToken":null,"fullRights":null}

Return:

*