Home Reference Source

Typedef

Static Public Summary
public
public
public
public
public
public
public
public
public
public
public
public

The URL of the image that is set in the background or a Blob containing an image.

public

The color used for the shapes.

public

The tool to use on user interaction.

Static Public

public AddressType: Object source

Properties:

NameTypeAttributeDescription
HOME *
WORK *
OTHER *

public ChatMessageDirection: Object source

Properties:

NameTypeAttributeDescription
INCOMING "incoming"
OUTGOING "outgoing"

public ChatMessageStatus: Object source

Properties:

NameTypeAttributeDescription
ERROR "error"
SENDING "sending"
SENT "sent"
RECEIVED "received"
DISPLAYED "displayed"
ACKNOWLEDGED "acknowledged"

public ChatMessageType: Object source

Properties:

NameTypeAttributeDescription
FILE "file"
TEXT "text"

public ChatParticipantRole: Object source

Properties:

NameTypeAttributeDescription
MEMBER "member"
ADMIN "admin"

public ChatParticipantState: Object source

Properties:

NameTypeAttributeDescription
ACTIVE "active"
INACTIVE "inactive"
GONE "gone"
COMPOSING "composing"
PAUSED "paused"

public ChatType: Object source

Properties:

NameTypeAttributeDescription
INDIVIDUAL "individual"
GROUP "group"

public MeetingParticipant: object source

Properties:

NameTypeAttributeDescription
userId string
  • optional

x

email string
  • optional

x

phone string
  • optional

x

public StatusEvent: Object source

Properties:

NameTypeAttributeDescription
status SessionStatus

The new status of the session

target Session

The session object

public StopEvent: Object source

Properties:

NameTypeAttributeDescription
data Blob

A Blob with the recorded data. For more information about how to process a Blob you can check Sending and receiving Binary Data or FileSaver.js

startTime number

Timestamp when the recording was started

stopTime number

Timestamp when the recording was stoped

target StreamRecorder

The StreamRecorder object

public WhiteboardHistoryItem: Object source

Properties:

NameTypeAttributeDescription
id string

the identifier of the stored shape.

previous string

previous shape state in stringified format.

current string

new shape state in stringified format.

public backgroundImage: string | Blob source

The URL of the image that is set in the background or a Blob containing an image.

public color: string source

The color used for the shapes. It is represented in a string (e.g.: 'green', 'red') or RGB (e.g.: '#00FF00', '#FF0000').

public tool: string source

The tool to use on user interaction. It is represented in a string. Valid values: null, 'select', 'add-line', 'freedraw', 'add-rect', 'add-circle', 'remove' (null means no tool is selected)