Class BriaClientAccount

Hierarchy

default<AccountEvents>
- BriaClientAccount

Index

Constructors

constructor

Events

Properties

accounts

Methods

Constructors

constructor

new BriaClientAccount(client: BriaClient): BriaClientAccount

Overrides default.constructor
- Defined in client/Account.ts:25
Parameters
- client: BriaClient
Returns BriaClientAccount

Events

accountCreate

accountCreate(account: Account): Promise<void> | void

Parameters
- account: Account
Returns Promise<void> | void

accountRemove

accountRemove(account: Account): Promise<void> | void

Parameters
- account: Account
Returns Promise<void> | void

accountUpdate

accountUpdate(account: Account): Promise<void> | void

Parameters
- account: Account
Returns Promise<void> | void

Properties

accounts

accounts: Account[] = []

Methods

getAccounts

getAccounts(accountType: AccountType): Promise<Account[]>

- Defined in client/Account.ts:87
Get static list of accounts

Instead of using this method, you should access client.account.accounts, this method is used when Bria posts an account update event internally

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiAccount.htm#GET/statusAccounts

Parameters
- accountType: AccountType
Returns Promise<Account[]>

populate

populate(): Promise<void>

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

Generated using TypeDoc