Class Session

Session objects manage communications for a given user identity. They are obtained by calling the createSession method of the Sippo object.

Hierarchy

EventEmitter2
- Session

Constructors

constructor

new Session(options?: ConstructorOptions): Session
Parameters
- Optional options: ConstructorOptions
Returns Session
Inherited from EventEmitter2.constructor
- Defined in node_modules/eventemitter2/eventemitter2.d.ts:37

Methods

connect

connect(): Promise<Session>
Activates the communications session with a gateway server.

Returns Promise<Session>
- Defined in src/session/Session.d.ts:33

createDataPipe

createDataPipe(participants: string[], label?: string): DataPipe
Creates a new data pipe instance for data exchange with the specified recipient.
Parameters
- participants: string[]
- Optional label: string
Returns DataPipe
- Defined in src/session/Session.d.ts:39

createSelfie

createSelfie(to: string): Promise<any>
Creates a new instance of a Selfie.
Parameters
- to: string
Returns Promise<any>
- Defined in src/session/Session.d.ts:44

createWhiteboard

createWhiteboard(participants: string[]): Promise<Whiteboard>
Creates a new instance of a Whiteboard.
Parameters
- participants: string[]
Returns Promise<Whiteboard>
- Defined in src/session/Session.d.ts:49

destroyPushToken

destroyPushToken(): any
Destroy every existent token for the deviceId of this session.

Returns any
- Defined in src/session/Session.d.ts:54

disconnect

disconnect(): Promise<void>
Ends a connected session.

Returns Promise<void>
- Defined in src/session/Session.d.ts:59

getAlias

getAlias(): string
Get user's alias.

Returns string
- Defined in src/session/Session.d.ts:64

getCapabilities

getCapabilities(): Set<string>
Retrieves an array with the underlying capabilities.

Returns Set<string>
- Defined in src/session/Session.d.ts:69

getChatManager

getChatManager(): Promise<ChatManager>
Retrieves the chat manager.

Returns Promise<ChatManager>
- Defined in src/session/Session.d.ts:74

getConferenceManager

getConferenceManager(): ConferenceManager
Retrieves a conference manager instance.

Returns ConferenceManager
- Defined in src/session/Session.d.ts:79

getContactRepository

getContactRepository(): ContactRepository
Returns ContactRepository
- Defined in src/session/Session.d.ts:81

getFileManager

getFileManager(): Promise<FileManager>
Retrieves the file manager.

Returns Promise<FileManager>
- Defined in src/session/Session.d.ts:86

getGatewayUsername

getGatewayUsername(): string
Returns the username in the gateway of the user owning this session.

Returns string
- Defined in src/session/Session.d.ts:91

getGroupRepository

getGroupRepository(): GroupRepository
Returns GroupRepository
- Defined in src/session/Session.d.ts:93

getLogger

getLogger(name: string): any
Retrieves a Logger instance to log events in the WAC.

Returns
A logger instance
Parameters
- name: string
  
  The name of the logger
Returns any
- Defined in src/session/Session.d.ts:100

getMeetingManager

getMeetingManager(): MeetingManager
Returns MeetingManager
- Defined in src/session/Session.d.ts:102

getPermissionManager

getPermissionManager(): PermissionManager
Retrieves the permission Manager.

Returns PermissionManager
- Defined in src/session/Session.d.ts:107

getPresence

getPresence(): Presence
Returns Presence
- Defined in src/session/Session.d.ts:129

getSessionToken

getSessionToken(): string
Get session token.

Returns string
- Defined in src/session/Session.d.ts:117

getStatus

getStatus(): SessionStatus
Retrieves the current status of this session.

Returns SessionStatus
- Defined in src/session/Session.d.ts:122

getUser

getUser(): User
Retrieve the User.

Returns User
- Defined in src/session/Session.d.ts:127

getUserRepository

getUserRepository(): UserRepository
Returns UserRepository
- Defined in src/session/Session.d.ts:131

getUsername

getUsername(): string
Returns the username of the user owning this session.

Returns string
- Defined in src/session/Session.d.ts:136

getVersion

getVersion(): object[]
Retrieves and array with version information.

Returns object[]
- Defined in src/session/Session.d.ts:141

getVoiceMailManager

getVoiceMailManager(): VoiceMailManager
Retrieves the voicemail manager

Returns VoiceMailManager
- Defined in src/session/Session.d.ts:112

notifyPushToken

notifyPushToken(tokenType: string, token: string): any
Notifies a push token to the WAC.
Parameters
- tokenType: string
- token: string
Returns any
- Defined in src/session/Session.d.ts:146

onConnectionLost

onConnectionLost(): void
Returns void
- Defined in src/session/Session.d.ts:148

onSessionReconnected

onSessionReconnected(): void
Returns void
- Defined in src/session/Session.d.ts:150

onSessionReconnecting

onSessionReconnecting(): void
Returns void
- Defined in src/session/Session.d.ts:152

onTransportClose

onTransportClose(): void
Returns void
- Defined in src/session/Session.d.ts:154

onUnknownClose

onUnknownClose(): void
Returns void
- Defined in src/session/Session.d.ts:156

resume

resume(): any
Resume current session, restoring WAC communication.

Returns any
- Defined in src/session/Session.d.ts:161

setSetting

setSetting(key: string, value: string): Session
Returns
Parameters
- key: string
  
  Key to modified
- value: string
  
  New value
Returns Session
- Defined in src/session/Session.d.ts:168

settings

settings(): Promise<any>
Retrieves a promise which is resolved with the settings array.

Returns Promise<any>
- Defined in src/session/Session.d.ts:173

suspend

suspend(): Promise<any>
Suspend current session: WAC will not send or receive any message.

Returns Promise<any>
- Defined in src/session/Session.d.ts:178

`Static` withOAuth2

withOAuth2(issuer: string, token: string, config: SessionConfig): Session
Parameters
- issuer: string
- token: string
- config: SessionConfig
Returns Session
- Defined in src/session/Session.d.ts:26

`Static` withSessionToken

withSessionToken(token: string, config: SessionConfig): Session
Parameters
- token: string
- config: SessionConfig
Returns Session
- Defined in src/session/Session.d.ts:28

`Static` withoutToken

withoutToken(issuer: string, config: SessionConfig): Session
Parameters
- issuer: string
- config: SessionConfig
Returns Session
- Defined in src/session/Session.d.ts:27

Generated using TypeDoc