Class BriaClientAuth

Hierarchy

default<AuthEvents>
- BriaClientAuth

Index

Constructors

constructor

Events

authenticationUpdate

Properties

authenticated

Methods

Constructors

constructor

new BriaClientAuth(client: BriaClient): BriaClientAuth

Overrides default.constructor
- Defined in client/Auth.ts:20
Parameters
- client: BriaClient
Returns BriaClientAuth

Events

authenticationUpdate

authenticationUpdate(ar: AuthResponse): Promise<void> | void

Parameters
- ar: AuthResponse
Returns Promise<void> | void

Properties

authenticated

authenticated: boolean = false

Methods

exit

exit(): Promise<XML>

- Defined in client/Auth.ts:76
Exit Bria client

Requires Bria Solo/Teams/Enterprise client version 6.4.0 or later

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiLoggingInOut.htm#getExit

Returns Promise<XML>

getAuthentication

getAuthentication(): Promise<AuthResponse>

- Defined in client/Auth.ts:89
Get authentication status

Requires Bria Solo/Teams/Enterprise client version 6.4.0 or later

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiLoggingInOut.htm#getStatusAuth

Returns Promise<AuthResponse>

populate

populate(): Promise<void>

Overrides default.populate
- Defined in client/Auth.ts:26
Returns Promise<void>

signIn

signIn(username: string, password: string): Promise<XML>

- Defined in client/Auth.ts:52
Sign in to Bria with provided credentials

Requires Bria Solo/Teams/Enterprise client version 6.4.0 or later

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiLoggingInOut.htm#getSignIn

Parameters
- username: string
- password: string
Returns Promise<XML>

signOut

signOut(): Promise<XML>

- Defined in client/Auth.ts:64
Sign out from Bria

Requires Bria Solo/Teams/Enterprise client version 6.4.0 or later

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiLoggingInOut.htm#getSignOut

Returns Promise<XML>

Generated using TypeDoc