Session
Extends:
Session objects manage communications for a given user identity. They are obtained by calling the Sippo#createSession method of the Sippo object.
Events
status
StatusEvent - Triggered every time the status of the session changes.incomingDataPipe
Datapipe - Triggered when an incoming data pipe is received during an active sessionincomingWhiteboard
Whiteboard -incomingSelfie
Selfie - Triggered when an Selfie request is receivedqs-connection-lost
- Triggered when the socket.io ping times out (deprecated)qs-transport-close
- Triggered when the socket is terminated (deprecated)qs-unknown-close
- Triggered when some other reason closed the socket (deprecated)
Method Summary
Public Methods | ||
public |
Activates the communications session with a gateway server. |
|
public |
createDataPipe(participants: String[], label: String): DataPipe Creates a new data pipe instance for data exchange with the specified recipient. |
|
public |
createSelfie(to: String): Promise Creates a new instance of a Selfie |
|
public |
createWhiteboard(participants: String[]): Promise{Whiteboard} Creates a new instance of a Whiteboard |
|
public |
Destroy every existent token for the deviceId of this session |
|
public |
async disconnect(): Promise Ends a connected session. |
|
public |
Get user's alias |
|
public |
Retrieves an array with the underlying capabilities |
|
public |
async getChatManager(): Promise<ChatManager> Retrieves the chat manager |
|
public |
Retrieves a conference manager instance |
|
public |
Returns the contact repository. |
|
public |
async getFileManager(): Promise<FileManager> Retrieves the file manager |
|
public |
Returns the username in the gateway of the user owning this session |
|
public |
Retrieves the group repository. |
|
public |
Retrieves a {Logger} instance to log events in the WAC. |
|
public |
Retrieves the meeting manager. |
|
public |
Retrieves the permissions manager. |
|
public |
getPresence(): * |
|
public |
Get session token |
|
public |
Retrieves the current status of this session. |
|
public |
Retrieve the User |
|
public |
getUserRepository(): UserRepository Returns the user repository. |
|
public |
getVersion(): Object[] Retrieves and array with version information. |
|
public |
getVoiceMailManager(): VoiceMailMananger Retrieves the voicemail manager |
|
public |
notifyPushToken(tokenType: string, token: string): Promise Notifies a push token to the WAC |
|
public |
Resume current session, restoring WAC communication |
|
public |
setSetting(key: String, value: String): Session |
|
public |
Retrieves a promise which is resolved with the settings array. |
|
public |
Suspend current session: WAC will not send or receive any message |
Public Methods
public async connect(): Promise<Session> source
Activates the communications session with a gateway server.
public createDataPipe(participants: String[], label: String): DataPipe source
Creates a new data pipe instance for data exchange with the specified recipient.
Throw:
public createSelfie(to: String): Promise source
Creates a new instance of a Selfie
Params:
Name | Type | Attribute | Description |
to | String | gateway username of the selfie recipient. |
public createWhiteboard(participants: String[]): Promise{Whiteboard} source
Creates a new instance of a Whiteboard
Params:
Name | Type | Attribute | Description |
participants | String[] | gateway usernames of the desired participants |
Return:
Promise{Whiteboard} |
public destroyPushToken(): Promise source
Destroy every existent token for the deviceId of this session
public getCapabilities(): ImmutableSet<string> source
Retrieves an array with the underlying capabilities
public getGatewayUsername(): String source
Returns the username in the gateway of the user owning this session
public getLogger(name: string): Logger source
Retrieves a {Logger} instance to log events in the WAC.
Params:
Name | Type | Attribute | Description |
name | string | The name of the logger |
Return:
Logger |
public getUserRepository(): UserRepository source
Returns the user repository.
Return:
UserRepository |
public getVoiceMailManager(): VoiceMailMananger source
Retrieves the voicemail manager
Return:
VoiceMailMananger |
public notifyPushToken(tokenType: string, token: string): Promise source
Notifies a push token to the WAC