Home Reference Source

References

summary
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 recovery

calls

summary
public

C Call

Provides access to methods for managing outgoing or incoming calls.

public

Manages the contacts and groups which they belongs to CallLogManager instance is obtained by calling the {Session#getCallLogManager} method

public
public

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

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
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

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

Provides access to methods for managing outgoing or incoming conferences.

public

This class allows access to the details of incoming Conference invitation.

public

This class allows access to the conference log.

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

Enum containing the possible end reasons of a conference.

public

Enum containing the possible status of a conference.

public
public
public
public
public
public

T Candidate: *

public
public

T MediaType: *

public
public

T Transfer: *

conferences/errors

summary
public
public

contacts

summary
public

Represents a contact.

public

Represents a group contact.

public

This class must not be instantiated.

public

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
public

DataPipe factory

public
public

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.

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

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.

instant-messages

summary
public
public

Enum containing the possible types of an instant message.

media

summary
public

Provides access to methods for managing actions related to local media.

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

Enum containing the possible status of a stream recorder.

public

meetings

summary
public

Represents a meeting.

public

ContactManager instance is obtained by calling the Session#getMeetingManager method of Session and must not be directly instantiated.

public

misc

summary
public

C Selfie

Provides access to methods for controlling a selfie.

public

E Blob

public
public
public
public
public
public
public
public

session

summary
public

This class is used to define a remote session where user has created a session.

public

Session objects manage communications for a given user identity.

public

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

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

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