Interface ILivechatRead

Hierarchy

ILivechatRead

Index

Methods

Methods

_fetchLivechatRoomMessages

_fetchLivechatRoomMessages(roomId: string): Promise<IMessage[]>

- Defined in src/definition/accessors/ILivechatRead.ts:35
experimental

we do not encourage the wider usage of this method, as we're evaluating its performance and fit for the API.

Parameters
- roomId: string
Returns Promise<IMessage[]>

getDepartmentsEnabledWithAgents

getDepartmentsEnabledWithAgents(): Promise<IDepartment[]>

- Defined in src/definition/accessors/ILivechatRead.ts:18
Returns Promise<IDepartment[]>

getLivechatDepartmentByIdOrName

getLivechatDepartmentByIdOrName(value: string): Promise<IDepartment>

- Defined in src/definition/accessors/ILivechatRead.ts:30
Parameters
- value: string
Returns Promise<IDepartment>

getLivechatRooms

getLivechatRooms(visitor: IVisitor, departmentId?: string): Promise<ILivechatRoom[]>

- Defined in src/definition/accessors/ILivechatRead.ts:19
Parameters
- visitor: IVisitor
- Optional departmentId: string
Returns Promise<ILivechatRoom[]>

getLivechatVisitorByEmail

getLivechatVisitorByEmail(email: string): Promise<IVisitor>

- Defined in src/definition/accessors/ILivechatRead.ts:27
Parameters
- email: string
Returns Promise<IVisitor>

getLivechatVisitorById

getLivechatVisitorById(id: string): Promise<IVisitor>

- Defined in src/definition/accessors/ILivechatRead.ts:26
Parameters
- id: string
Returns Promise<IVisitor>

getLivechatVisitorByPhoneNumber

getLivechatVisitorByPhoneNumber(phoneNumber: string): Promise<IVisitor>

- Defined in src/definition/accessors/ILivechatRead.ts:29
Parameters
- phoneNumber: string
Returns Promise<IVisitor>

getLivechatVisitorByToken

getLivechatVisitorByToken(token: string): Promise<IVisitor>

- Defined in src/definition/accessors/ILivechatRead.ts:28
Parameters
- token: string
Returns Promise<IVisitor>

getLivechatVisitors

getLivechatVisitors(query: object): Promise<IVisitor[]>

- Defined in src/definition/accessors/ILivechatRead.ts:25
deprecated

This method does not adhere to the conversion practices applied elsewhere in the Apps-Engine and will be removed in the next major version. Prefer the alternative methods to fetch visitors.

Parameters
- query: object
Returns Promise<IVisitor[]>

isOnline

isOnline(departmentId?: string): boolean

- Defined in src/definition/accessors/ILivechatRead.ts:12
Gets online status of the livechat.

deprecated

use isOnlineAsync instead

Parameters
- Optional departmentId: string
  
  (optional) the id of the livechat department
Returns boolean

isOnlineAsync

isOnlineAsync(departmentId?: string): Promise<boolean>

- Defined in src/definition/accessors/ILivechatRead.ts:17
Gets online status of the livechat.

Parameters
- Optional departmentId: string
  
  (optional) the id of the livechat department
Returns Promise<boolean>

Generated using TypeDoc