Class SupportChat

emitter

Readonly firstUnreadMessage

Readonly messages

addParticipant

• addParticipant(participant): Promise<void>

• Parameters

  • participant: string

  Returns Promise<void>

archive

• archive(): Promise<void>

• Returns Promise<void>

cancelPendingMessage

• cancelPendingMessage(message): Promise<void>

• Parameters

  • message: ChatMessage

  Returns Promise<void>

delete

• delete(): Promise<void>

• Returns Promise<void>

expelParticipant

• expelParticipant(participant): Promise<void>

• Parameters

  • participant: string

  Returns Promise<void>

fetch

• fetch(minimum?): Promise<void>

• Parameters

  • Optional minimum: number

  Returns Promise<void>

getFileMessages

• getFileMessages(): List<ChatMessage>

• Returns List<ChatMessage>

getFirstUnreadMessage

• getFirstUnreadMessage(): ChatMessage

• Returns ChatMessage

getFirstUnreadMessage$

• getFirstUnreadMessage$(): Observable<ChatMessage>

• Returns Observable<ChatMessage>

getId

• getId(): string

• Returns string

getMessages

• getMessages(): List<ChatMessage>

• Returns List<ChatMessage>

getMessages$

• getMessages$(): Observable<List<ChatMessage>>

• Returns Observable<List<ChatMessage>>

getName

• getName(): string

• Returns string

getParticipants

• getParticipants(): Map<string, ChatParticipantRole>

• Returns Map<string, ChatParticipantRole>

getPendingMessages

• getPendingMessages(): List<ChatMessage>

• Returns List<ChatMessage>

getRemoteParticipants

• getRemoteParticipants(): Map<string, ChatParticipantState>

• Returns Map<string, ChatParticipantState>

getRole

• getRole(): ChatParticipantRole

• Returns ChatParticipantRole

getSubject

• getSubject(): string

• Returns string

getType

• getType(): ChatType

• Returns ChatType

getUnreadMessageCount

• getUnreadMessageCount(): number

• Returns number

getUnreadMessageCount$

• getUnreadMessageCount$(): Observable<number>

• Returns Observable<number>

isOldestMessageRecovered

• isOldestMessageRecovered(): boolean

• Returns boolean

leave

• leave(): Promise<void>

• Leaves the current Support Chat

  If leaving participant is the chat's agent, the support chat is finished.

  Returns Promise<void>

resetUnreadMessageCount

• resetUnreadMessageCount(): Promise<void>

• Returns Promise<void>

sendFile

• sendFile(file): Promise<void>

• Parameters

  • file: File

  Returns Promise<void>

sendText

• sendText(text): Promise<void>

• Parameters

  • text: string

  Returns Promise<void>

setParticipantRole

• setParticipantRole(participant, role): Promise<void>

• Parameters

  • participant: string
  • role: ChatParticipantRole

  Returns Promise<void>

setState

• setState(state): Promise<void>

• Parameters

  • state: ChatParticipantState

  Returns Promise<void>

setSubject

• setSubject(subject): Promise<void>

• Parameters

  • subject: string

  Returns Promise<void>

sync

• sync(): Promise<void>

• Returns Promise<void>