Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChatThreadClient

Package version

The client to do chat operations

Hierarchy

  • ChatThreadClient

Index

Constructors

constructor

Properties

threadId

threadId: string

Thread ID of the ChatThreadClient

Methods

addParticipants

deleteMessage

  • Deletes a message identified by threadId and messageId

    Parameters

    • messageId: string

      The message id of the message.

    • Default value options: DeleteMessageOptions = {}

      Operation options.

    Returns Promise<void>

getMessage

  • Gets a chat message identified by messageId. Returns the specific message.

    Parameters

    • messageId: string

      The message id of the message.

    • Default value options: GetMessageOptions = {}

      Operation options.

    Returns Promise<ChatMessage>

listMessages

  • Gets a list of message from a thread identified by threadId. Returns the list of the messages.

    Parameters

    Returns PagedAsyncIterableIterator<ChatMessage>

listParticipants

  • Gets the participants of the thread identified by threadId. Returns the lists of the participants.

    Parameters

    Returns PagedAsyncIterableIterator<ChatParticipant>

listReadReceipts

  • Gets a list of read receipt from a thread identified by threadId. Returns the list of the messages.

    Parameters

    Returns PagedAsyncIterableIterator<ChatMessageReadReceipt>

removeParticipant

  • Removes participant from the thread identified by threadId.

    Parameters

    • participant: CommunicationIdentifier

      Thread participant to remove from the thread roster

    • Default value options: RemoveParticipantOptions = {}

      Operation options.

    Returns Promise<void>

sendMessage

sendReadReceipt

sendTypingNotification

  • Sends a typing notification to the thread. Doesn't attempt to send if the time since last notification is smaller than the minimum typing interval

    Parameters

    Returns Promise<boolean>

    True if the typing message notification could be sent, otherwise false.

updateMessage

  • Updates a message identified by threadId and messageId

    Parameters

    • messageId: string

      The message id of the message.

    • Default value options: UpdateMessageOptions = {}

      Operation options.

    Returns Promise<void>

updateTopic

  • Updates a thread's topic.

    Parameters

    • topic: string

      The topic needs to be updated to.

    • Default value options: UpdateTopicOptions = {}

      Operation options.

    Returns Promise<void>

Generated using TypeDoc