Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILivechatRead

Hierarchy

  • ILivechatRead

Index

Methods

getLivechatDepartmentByIdOrName

  • getLivechatDepartmentByIdOrName(value: string): Promise<IDepartment | undefined>

getLivechatRooms

getLivechatVisitorByEmail

  • getLivechatVisitorByEmail(email: string): Promise<IVisitor | undefined>

getLivechatVisitorById

  • getLivechatVisitorById(id: string): Promise<IVisitor | undefined>

getLivechatVisitorByPhoneNumber

  • getLivechatVisitorByPhoneNumber(phoneNumber: string): Promise<IVisitor | undefined>

getLivechatVisitorByToken

  • getLivechatVisitorByToken(token: string): Promise<IVisitor | undefined>

getLivechatVisitors

  • getLivechatVisitors(query: object): Promise<Array<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.

    Parameters

    • query: object

    Returns Promise<Array<IVisitor>>

isOnline

  • isOnline(departmentId?: string): boolean
  • 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>
  • Gets online status of the livechat.

    Parameters

    • Optional departmentId: string

      (optional) the id of the livechat department

    Returns Promise<boolean>

Generated using TypeDoc