Home Reference Source

References

summary
public	C Conference
public	C ConferenceManager 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	C StreamRecorder
public	F createSession(issuer: string, token: string, config: Object): Promise<Session> Factory method for session creation
public	F getAuthProviders(wacUri: string): Promise<ProviderInfo[]> Allows obtaining the available providers enabled in the specified WAC instance
public	F recoverSession(token: string, config: Object): Promise<Session> Factory method for session creation

calls

summary
public	C Call Provides access to methods for managing outgoing or incoming calls.
public	C CallLog Manages the contacts and groups which they belongs to CallLogManager instance is obtained by calling the {Session#getCallLogManager} method
public	C CallLogEntry
public	C CallManager This class provides access to every call related feature This class must never be directly instantiated, instances of this class can be obtained using Session#getCallManager.
public	C CallRemoteRecorder This class creates an instances that can indicate to the WAC when he has to start/stop a recording using the source specified by param
public	C RemoteCall
public	V CallDirection: Enum Enum containing the possible directions of a call.
public	V CallEndReason: Enum Enum containing the possible end reasons of a call.
public	V CallStatus: Enum Enum containing the possible status of a call.
public	T MediaTypes: Object

chat

summary
public	C Chat Provides access to methods for managing a chat room.
public	C ChatManager Provides access to methods for using chat.
public	C ChatMessage Instances of this class represents a message of the chat.
public	C ChatMessageFile Instances of this class represents a file in a chat message.
public	V ChatMessageDirection: Enum Enum containing the possible directions of a chat message.
public	V ChatMessageStatus: Enum Enum containing the possible status of chat message.
public	V ChatMessageType: Enum Enum containing the possible types of a chat message.
public	V ChatParticipantRole: Enum Enum containing the possible roles of a chat participant.
public	V ChatParticipantState: Enum Enum containing the possible states of chat participant.
public	V ChatType: Enum Enum containing the possible types of a chat.

conferences

summary
public	C Conference Provides access to methods for managing outgoing or incoming conferences.
public	C ConferenceInvite This class allows access to the details of incoming Conference invitation.
public	C ConferenceLog This class allows access to the conference log.
public	C ConferenceLogEntry This class allows access to the details of each entry of the conference log
public	C ConferenceManager 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	C Invitation 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.
public	T EventInfo: Object
public	T LocalStreamEvent: Object
public	T RemoteStreamAddedEvent: Object
public	T RemoteStreamRemovedEvent: Object
public	T gatewayUsername: string
public	T Candidate: *
public	T Invite: Object
public	T MediaType: *
public	T Participant: *
public	T Transfer: *

contacts

summary
public	C Contact Represents a contact.
public	C ContactManager ContactManager instance is obtained by calling the Session#getContactManager method of Session and must not be directly instantiated.
public	C ContactRetriever
public	C ContactSynchronizer Keeps the wac contacts up to date with device contacts.
public	C FavoriteContact
public	C GroupContact Represents a group contact.
public	C OwnPresence This class must not be instantiated.
public	C Presence This class must not be instantiated.
public	V PresenceActivity: {"unknown": string, "appointment": string, "away": string, "breakfast": string, "busy": string, "dinner": string, "holiday": string, "in-transit": string, "looking-for-work": string, "lunch": string, "meal": string, "meeting": string, "on-the-phone": string, "other": string, "performance": string, "permanent-absence": string, "playing": string, "presentation": string, "shopping": string, "sleeping": string, "spectator": string, "steering": string, "travel": string, "tv": string, "vacation": string, "working": string, "worship": string}
public	V PresenceMood: {"unknown": string, "afraid": string, "amazed": string, "angry": string, "annoyed": string, "anxious": string, "ashamed": string, "bored": string, "brave": string, "calm": string, "cold": string, "confused": string, "contented": string, "cranky": string, "curious": string, "depressed": string, "disappointed": string, "disgusted": string, "distracted": string, "embarrassed": string, "excited": string, "flirtatious": string, "frustrated": string, "grumpy": string, "guilty": string, "happy": string, "hot": string, "humbled": string, "humiliated": string, "hungry": string, "hurt": string, "impressed": string, "in_awe": string, "in_love": string, "indignant": string, "interested": string, "invincible": string, "jealous": string, "lonely": string, "mean": string, "moody": string, "nervous": string, "neutral": string, "offended": string, "other": string, "playful": string, "proud": string, "relieved": string, "remorseful": string, "restless": string, "sad": string, "sarcastic": string, "serious": string, "shocked": string, "shy": string, "sick": string, "sleepy": string, "stressed": string, "surprised": string, "thirsty": string, "worried": string}

datapipe

summary
public	C DataChannelDataPipe
public	C DataPipeFactory DataPipe factory
public	C WacDataPipe
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.

summary
public	C FileManager
public	C FileUpload Provides access to methods for uploading a file.
public	C FileUploadManager 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	C GroupManager This class allows manager the groups.

instant-messages

summary
public	C InstantMessage
public	V InstantMessageType: Enum Enum containing the possible types of an instant message.

media

summary
public	C LocalMediaHandler Provides access to methods for managing actions related to local media.
public	C ManagedStream This class provides access to media control functions during a call This class must never be directly instantiated
public	C StreamRecorder This class allows to record a stream.
public	V StreamRecorderStatus: Enum Enum containing the possible status of a stream recorder.
public	T StopEvent: Object

meetings

summary
public	C Meeting Represents a meeting.
public	C MeetingManager ContactManager instance is obtained by calling the Session#getMeetingManager method of Session and must not be directly instantiated.

misc

summary
public	C Selfie Provides access to methods for controlling a selfie.
public	E Blob
public	E ImmutableList
public	E ImmutableMap
public	E ImmutableSet
public	E MediaDeviceInfo
public	E MediaStream
public	E MediaStreamConstraints
public	E MediaStreamTrack

session

summary
public	C RemoteSession 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	C SessionError Possible messages of the errors: UNAUTHORIZED WAC_INTERNAL_ERROR WAC_REGISTER_ERROR STACK_REGISTER_ERROR WAC_UNREGISTER_ERROR STACK_UNREGISTER_ERROR
public	C User Represents a user.
public	V SessionStatus: Enum Enum containing the possible status of a session.
public	T StatusEvent: Object

support

summary
public	C SupportService This class provides a wrapper over the ConferenceManager class that allows to call an agent.

whiteboard

summary
public	C Whiteboard Provides access to methods for creating whiteboards.
public	C WhiteboardHistory 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	T color: string The color used for the shapes.
public	T tool: string The tool to use on user interaction.
public	T WhiteboardHistoryItem: Object

Directories

instant-messages