Interface ILivechatRead

Hierarchy

ILivechatRead

Index

Methods

_fetchLivechatRoomMessages getDepartmentsEnabledWithAgents getLivechatDepartmentByIdOrName getLivechatOpenRoomsByAgentId getLivechatRooms getLivechatTotalOpenRoomsByAgentId getLivechatVisitorByEmail getLivechatVisitorById getLivechatVisitorByPhoneNumber getLivechatVisitorByToken getLivechatVisitors isOnline isOnlineAsync

Methods

_fetchLivechatRoomMessages

_fetchLivechatRoomMessages(roomId): Promise<IMessage[]>
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[]>
- Defined in src/definition/accessors/ILivechatRead.ts:37

getDepartmentsEnabledWithAgents

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

getLivechatDepartmentByIdOrName

getLivechatDepartmentByIdOrName(value): Promise<IDepartment>
Parameters
- value: string
Returns Promise<IDepartment>
- Defined in src/definition/accessors/ILivechatRead.ts:32

getLivechatOpenRoomsByAgentId

getLivechatOpenRoomsByAgentId(agentId): Promise<ILivechatRoom[]>
Parameters
- agentId: string
Returns Promise<ILivechatRoom[]>
- Defined in src/definition/accessors/ILivechatRead.ts:20

getLivechatRooms

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

getLivechatTotalOpenRoomsByAgentId

getLivechatTotalOpenRoomsByAgentId(agentId): Promise<number>
Parameters
- agentId: string
Returns Promise<number>
- Defined in src/definition/accessors/ILivechatRead.ts:21

getLivechatVisitorByEmail

getLivechatVisitorByEmail(email): Promise<IVisitor>
Parameters
- email: string
Returns Promise<IVisitor>
- Defined in src/definition/accessors/ILivechatRead.ts:29

getLivechatVisitorById

getLivechatVisitorById(id): Promise<IVisitor>
Parameters
- id: string
Returns Promise<IVisitor>
- Defined in src/definition/accessors/ILivechatRead.ts:28

getLivechatVisitorByPhoneNumber

getLivechatVisitorByPhoneNumber(phoneNumber): Promise<IVisitor>
Parameters
- phoneNumber: string
Returns Promise<IVisitor>
- Defined in src/definition/accessors/ILivechatRead.ts:31

getLivechatVisitorByToken

getLivechatVisitorByToken(token): Promise<IVisitor>
Parameters
- token: string
Returns Promise<IVisitor>
- Defined in src/definition/accessors/ILivechatRead.ts:30

getLivechatVisitors

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

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.
- Defined in src/definition/accessors/ILivechatRead.ts:27

isOnline

isOnline(departmentId?): boolean
Gets online status of the livechat.
Parameters
- Optional departmentId: string
  
  (optional) the id of the livechat department
Returns boolean

Deprecated
use isOnlineAsync instead
- Defined in src/definition/accessors/ILivechatRead.ts:12

isOnlineAsync

isOnlineAsync(departmentId?): Promise<boolean>
Gets online status of the livechat.
Parameters
- Optional departmentId: string
  
  (optional) the id of the livechat department
Returns Promise<boolean>
- Defined in src/definition/accessors/ILivechatRead.ts:17

Generated using TypeDoc