Class Session

status$

connect

• connect(): Promise<Session>

• Activates the communications session with a gateway server.

  Returns Promise<Session>

createDataPipe

• createDataPipe(participants, label?): DataPipe

• Creates a new data pipe instance for data exchange with the specified recipient.

  Parameters

  • participants: string[]
  • Optional label: string

  Returns DataPipe

createSelfie

• createSelfie(to): Promise<any>

• Creates a new instance of a Selfie.

  Parameters

  • to: string

  Returns Promise<any>

createWhiteboard

• createWhiteboard(participants): Promise<Whiteboard>

• Creates a new instance of a Whiteboard.

  Parameters

  • participants: string[]

  Returns Promise<Whiteboard>

destroyPushToken

• destroyPushToken(): any

• Destroy every existent token for the deviceId of this session.

  Returns any

disconnect

• disconnect(): Promise<void>

• Ends a connected session.

  Returns Promise<void>

getAlias

• getAlias(): string

• Get user's alias.

  Returns string

getCapabilities

• getCapabilities(): Set<string>

• Retrieves an array with the underlying capabilities.

  Returns Set<string>

getChatManager

• getChatManager(): Promise<ChatManager>

• Retrieves the chat manager.

  Returns Promise<ChatManager>

getConferenceManager

• getConferenceManager(): ConferenceManager

• Retrieves a conference manager instance.

  Returns ConferenceManager

getContactRepository

• getContactRepository(): ContactRepository

• Returns ContactRepository

getGatewayUsername

• getGatewayUsername(): string

• Returns the username in the gateway of the user owning this session.

  Returns string

getGroupRepository

• getGroupRepository(): GroupRepository

• Returns GroupRepository

getLogger

• getLogger(name): any

• Retrieves a Logger instance to log events in the WAC.

  Parameters

  • name: string

    The name of the logger

  Returns any

  A logger instance

getMeetingManager

• getMeetingManager(): MeetingManager

• Returns MeetingManager

getPermissionManager

• getPermissionManager(): PermissionManager

• Retrieves the permission Manager.

  Returns PermissionManager

getPresence

• getPresence(): Presence

• Returns Presence

getSessionToken

• getSessionToken(): string

• Get session token.

  Returns string

getStatus

• getStatus(): SessionStatus

• Retrieves the current status of this session.

  Returns SessionStatus

getUser

• getUser(): User

• Retrieve the User.

  Returns User

getUserRepository

• getUserRepository(): UserRepository

• Returns UserRepository

getUsername

• getUsername(): string

• Returns the username of the user owning this session.

  Returns string

getVersion

• getVersion(): object[]

• Retrieves and array with version information.

  Returns object[]

getVoiceMailManager

• getVoiceMailManager(): VoiceMailManager

• Retrieves the voicemail manager

  Returns VoiceMailManager

notifyPushToken

• notifyPushToken(tokenType, token): Promise<void>

• Notifies a push token to the WAC.

  Parameters

  • tokenType: "apn" | "ms-teams" | "web-push" | "firebase"
  • token: string

  Returns Promise<void>

resume

• resume(): any

• Resume current session, restoring WAC communication.

  Returns any

setSetting

• setSetting(key, value): Session

• Parameters

  • key: string

    Key to modified
  • value: string

    New value

  Returns Session

settings

• settings(): Promise<any>

• Retrieves a promise which is resolved with the settings array.

  Returns Promise<any>

suspend

• suspend(): Promise<any>

• Suspend current session: WAC will not send or receive any message.

  Returns Promise<any>

Static withOAuth2

• withOAuth2(token, config): Session

• Parameters

  • token: undefined | string
  • config: SessionConfig

  Returns Session

Static withSessionToken

• withSessionToken(token, config): Session

• Parameters

  • token: string
  • config: SessionConfig

  Returns Session