References
summary | ||
public |
F async createAnonymousSession(issuer: string, config: Object): Promise<Session> Factory method for anonymous user session creation |
|
public |
Factory method for session creation |
|
public |
F async recoverSession(token: string, config: Object): Promise<Session> Factory method for session recovery |
chat
summary | ||
public |
C Chat Provides access to methods for managing a chat room. |
|
public |
Provides access to methods for using chat. |
|
public |
Instances of this class represents a message of the chat. |
|
public |
Instances of this class represents a file in a chat message. |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
conferences
summary | ||
public |
This class allows access to the details of incoming Conference invitation. |
|
public |
This class allows access to the details of each entry of the conference log |
|
public |
This class provides access to every conference related feature This class must never be directly instantiated, instances of this class can be obtained using Session#getConferenceManager. |
|
public |
This class allows access to the details of each outgoing invitation in a Conference |
|
public |
V ConferenceEndReason: Enum Enum containing the possible end reasons of a conference. |
|
public |
V ConferenceStatus: Enum Enum containing the possible status of a conference. |
conferences/errors
summary | ||
public |
|
|
public |
|
contacts
summary | ||
public |
Allows retrieving, updating and creating contacts. |
|
public |
|
datapipe
summary | ||
public |
DataPipe factory |
|
public |
|
|
public |
I DataPipe Provides access to methods for managing an outgoing or an incoming data pipe DataPipe objects are obtained by calling the {Session#createDataPipe} method or handling the incomingDataPipe event of a connected {Session} instance. |
|
public |
V DataPipeStatus: Enum Enum containing the possible states of a datapipe. |
|
public |
V DataPipeType: Enum Enum containing the possible directions of a datapipe. |
errors
summary | ||
public |
|
file-sharing
summary | ||
public |
|
|
public |
Provides access to methods for uploading a file. |
|
public |
this class is experimental.
FileUploadManager objects allows creating and receiving file transfers They are obtained by calling the Session#createFileSharingManager method of a Session object |
|
public |
V FileUploadStatus: Enum Enum containing the possible status of a file upload. |
groups
summary | ||
public |
C Group This class allows access to the details of each group |
|
public |
This class allows manager the groups. |
media
summary | ||
public |
This class provides access to media control functions during a call This class must never be directly instantiated |
|
public |
This class allows to record a stream. |
|
public |
V StreamRecorderStatus: Enum Enum containing the possible status of a stream recorder. |
|
public |
|
meetings
summary | ||
public |
C Meeting Represents a meeting. |
|
public |
ContactManager instance is obtained by calling the Session#getMeetingManager method of Session and must not be directly instantiated. |
|
public |
|
misc
permissions
summary | ||
public |
This class allows manager the permissions. |
session
summary | ||
public |
This class is used to define a remote session where user has created a session. |
|
public |
C Session Session objects manage communications for a given user identity. |
|
public |
Possible messages of the errors:
|
|
public |
C User Represents a user. |
|
public |
V SessionStatus: Enum Enum containing the possible status of a session. |
|
public |
|
users
summary | ||
public |
C Presence Allows retrieving and updating presence related information of the current user. |
utils
summary | ||
public |
F fromEvent(emitter: *, eventName: *): * |
|
public |
F bufferDebounce(time: *): * Emits an array of the values emitted by the source after t seconds without an emission. |
|
public |
F bufferDuringTime(time: *) Emits an array of the values emitted by the source for t seconds after an emission. |
|
public |
F async scaleImage(file: *, width: *, height: *, format: *): * Scales the image provided to the given width and height. |
voice-mail
summary | ||
public |
|
whiteboard
summary | ||
public |
Provides access to methods for creating whiteboards. |
|
public |
Class that stores the changes made in the whiteboard and allows you to get the shapes that undo the changes introduced in the whiteboard. |
|
public |
T backgroundImage: string | Blob 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. |
|
public |
|