Class Chat

constructor

• new Chat(api: Api): Chat

  Parameters

  • api: Api

  Returns Chat

Readonlyapi

Readonlyconversations$

Readonlyerror$

ReadonlyhasMore$

Readonlyloading$

Readonlymessages$

ReadonlyselectedUser$

ReadonlytypingUsers$

Readonlyunread$

Readonlyusers$

available

• available(): Promise<boolean>

  Returns Promise<boolean>

destroy

• destroy(): void

  Returns void

initialize

• initialize(force?: boolean): Promise<void>

  Parameters

  • force: boolean = false

  Returns Promise<void>

loadConversations

• loadConversations(): Promise<ChatConversation[]>

  Returns Promise<ChatConversation[]>

loadDirectory

• loadDirectory(search?: string, cursor?: string): Promise<ChatUser[]>

  Parameters

  • search: string = ''
  • Optionalcursor: string

  Returns Promise<ChatUser[]>

loadHistory

• loadHistory(userId: number, before?: string): Promise<ChatMessage[]>

  Parameters

  • userId: number
  • Optionalbefore: string

  Returns Promise<ChatMessage[]>

markLatestRead

• markLatestRead(): Promise<void>

  Returns Promise<void>

retry

• retry(message: ChatMessage): Promise<ChatMessage>

  Parameters

  • message: ChatMessage

  Returns Promise<ChatMessage>

selectUser

• selectUser(user: ChatUser): Promise<void>

  Parameters

  • user: ChatUser

  Returns Promise<void>

send

• send(userId: number, body: string, clientId?: string): Promise<ChatMessage>

  Parameters

  • userId: number
  • body: string
  • clientId: string = ...

  Returns Promise<ChatMessage>

setReadVisibility

• setReadVisibility(visible: () => boolean): () => void

  Only the visible chat window may acknowledge messages as seen.

  Parameters

  • visible: () => boolean

  Returns () => void

setTyping

• setTyping(userId: number, typing: boolean): Promise<void>

  Parameters

  • userId: number
  • typing: boolean

  Returns Promise<void>