Typedef

Static Public Summary
public	AddressType: Object
public	ChatMessageDirection: Object
public	ChatMessageStatus: Object
public	ChatMessageType: Object
public	ChatParticipantRole: Object
public	ChatParticipantState: Object
public	ChatType: Object
public	EventInfo: Object
public	LocalStreamEvent: Object this typedef was deprecated.
public	MediaTypes: Object
public	MeetingParticipant: object
public	RemoteStreamAddedEvent: Object
public	RemoteStreamRemovedEvent: Object
public	SpeakerChangedEvent: Object
public	StatusEvent: Object
public	StopEvent: Object
public	WhiteboardHistoryItem: Object
public	backgroundImage: string \| Blob The URL of the image that is set in the background or a Blob containing an image.
public	color: string The color used for the shapes.
public	gatewayUsername: string
public	tool: string The tool to use on user interaction.

Static Public

public AddressType: Object source

Properties:

Name	Type	Attribute	Description
HOME	*
WORK	*
OTHER	*

public ChatMessageDirection: Object source

Properties:

Name	Type	Attribute	Description
INCOMING	"incoming"
OUTGOING	"outgoing"

public ChatMessageStatus: Object source

Properties:

Name	Type	Attribute	Description
ERROR	"error"
SENDING	"sending"
SENT	"sent"
RECEIVED	"received"
DISPLAYED	"displayed"
ACKNOWLEDGED	"acknowledged"

public ChatMessageType: Object source

Properties:

Name	Type	Attribute	Description
FILE	"file"
TEXT	"text"

public ChatParticipantRole: Object source

Properties:

Name	Type	Attribute	Description
MEMBER	"member"
ADMIN	"admin"

public ChatParticipantState: Object source

Properties:

Name	Type	Attribute	Description
ACTIVE	"active"
INACTIVE	"inactive"
GONE	"gone"
COMPOSING	"composing"
PAUSED	"paused"

public ChatType: Object source

Properties:

Name	Type	Attribute	Description
INDIVIDUAL	"individual"
GROUP	"group"

public EventInfo: Object source

Properties:

Name	Type	Attribute	Description
participant	string		gatewayUsername of a participant in the conference
reason	string	optional default: 'IN_CALL'\|'HOLD'	reason to know if the participant is on hold or not

public LocalStreamEvent: Object source

this typedef was deprecated.

Properties:

Name	Type	Attribute	Description
participant	string		gatewayUsername of the local stream
{@link	*		ManagedStream} stream

public MediaTypes: Object source

Properties:

Name	Type	Attribute	Description
audio	boolean
video	boolean
screen	boolean

public MeetingParticipant: object source

Properties:

Name	Type	Attribute	Description
userId	string	optional	x
email	string	optional	x
phone	string	optional	x

public RemoteStreamAddedEvent: Object source

Properties:

Name	Type	Attribute	Description
participant	string		gatewayUsername of the local stream
reason	string	optional default: 'NEW'\|'UNHOLD'	reason of stream addition
{@link	*		ManagedStream} stream

public RemoteStreamRemovedEvent: Object source

Properties:

Name	Type	Attribute	Description
participant	string		gatewayUsername of the local stream
reason	string	optional default: 'GONE'\|'HOLD'	reason of stream addition
{@link	*		ManagedStream} stream

public SpeakerChangedEvent: Object source

Properties:

Name	Type	Attribute	Description
participant	string		gatewayUsername of the conference participant
isTalking	boolean		indicates the new value for the associated participant

public StatusEvent: Object source

Properties:

Name	Type	Attribute	Description
status	SessionStatus		The new status of the session
target	Session		The session object

public StopEvent: Object source

Properties:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
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 gatewayUsername: string source

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)