Class BriaClientHistory

Hierarchy

default<HistoryEvents>
- BriaClientHistory

Index

Constructors

constructor

Events

historyUpdated

Properties

missedCalls

Methods

Constructors

constructor

new BriaClientHistory(client: BriaClient): BriaClientHistory

Overrides default.constructor
- Defined in client/History.ts:29
Parameters
- client: BriaClient
Returns BriaClientHistory

Events

historyUpdated

historyUpdated(): Promise<void> | void

Returns Promise<void> | void

Properties

missedCalls

missedCalls: number = 0

Methods

getCallHistory

getCallHistory(type: HistoryType, count?: number): Promise<HistoryEntry[]>

- Defined in client/History.ts:70
Get entries from call history

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHistory.htm#getStatusCallHistory

Parameters
- type: HistoryType
- count: number = 10
  
  default 10
Returns Promise<HistoryEntry[]>

getCallHistoryItem

getCallHistoryItem(id: string): Promise<HistoryEntry>

- Defined in client/History.ts:108
Get a single call history item

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHistory.htm#getStatusCallHistoryItem

Parameters
- id: string
Returns Promise<HistoryEntry>

getMissedCallCount

getMissedCallCount(): Promise<number>

- Defined in client/History.ts:139
Get missed call count

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHistory.htm#getStatusMissedCall

Returns Promise<number>

populate

populate(): Promise<void>

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

showHistory

showHistory(type: HistoryType, text?: string): Promise<XML>

- Defined in client/History.ts:60
Show history panel and take window focus

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHistory.htm#getShowHistoryHistory

Parameters
- type: HistoryType
- Optional text: string
  
  Filter text to input automatically
Returns Promise<XML>

Generated using TypeDoc