Package version:

Class ChatThreadClient

The client to do chat operations

Hierarchy

ChatThreadClient

Index

Constructors

constructor

new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions): ChatThreadClient
Parameters
- endpoint: string
- threadId: string
- credential: CommunicationTokenCredential
- options: ChatThreadClientOptions = {}
Returns ChatThreadClient
- Defined in chatThreadClient.ts:70

Properties

`Readonly` threadId

threadId: string

Thread ID of the ChatThreadClient

Methods

addParticipants

addParticipants(request: AddParticipantsRequest, options?: OperationOptions): Promise<AddChatParticipantsResult>
Adds the details of chat participants belonging to the thread identified by threadId.
Parameters
- request: AddParticipantsRequest
  
  Thread participants' details to add in the thread roster
- options: OperationOptions = {}
  
  Operation options.
Returns Promise<AddChatParticipantsResult>
- Defined in chatThreadClient.ts:290

deleteMessage

deleteMessage(messageId: string, options?: OperationOptions): Promise<void>
Deletes a message identified by threadId and messageId
Parameters
- messageId: string
  
  The message id of the message.
- options: OperationOptions = {}
  
  Operation options.
Returns Promise<void>
- Defined in chatThreadClient.ts:255

getMessage

getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>
Gets a chat message identified by messageId. Returns the specific message.
Parameters
- messageId: string
  
  The message id of the message.
- options: OperationOptions = {}
  
  Operation options.
Returns Promise<ChatMessage>
- Defined in chatThreadClient.ts:164

getProperties

getProperties(options?: OperationOptions): Promise<ChatThreadProperties>
Gets a chat thread. Returns the chat thread.
Parameters
- options: OperationOptions = {}
  
  Operation options.
Returns Promise<ChatThreadProperties>
- Defined in chatThreadClient.ts:102

listMessages

listMessages(options?: RestListMessagesOptions): PagedAsyncIterableIterator<ChatMessage>
Gets a list of message from a thread identified by threadId. Returns the list of the messages.
Parameters
- options: RestListMessagesOptions = {}
  
  Get messages options.
Returns PagedAsyncIterableIterator<ChatMessage>
- Defined in chatThreadClient.ts:220

listParticipants

listParticipants(options?: RestListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant>
Gets the participants of the thread identified by threadId. Returns the lists of the participants.
Parameters
- options: RestListParticipantsOptions = {}
  
  Operation options.
Returns PagedAsyncIterableIterator<ChatParticipant>
- Defined in chatThreadClient.ts:351

listReadReceipts

listReadReceipts(options?: RestListReadReceiptsOptions): PagedAsyncIterableIterator<ChatMessageReadReceipt>
Gets a list of read receipt from a thread identified by threadId. Returns the list of the messages.
Parameters
- options: RestListReadReceiptsOptions = {}
  
  Get messages options.
Returns PagedAsyncIterableIterator<ChatMessageReadReceipt>
- Defined in chatThreadClient.ts:498

removeParticipant

removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>
Removes participant from the thread identified by threadId.
Parameters
- participant: CommunicationIdentifier
  
  Thread participant to remove from the thread roster
- options: OperationOptions = {}
  
  Operation options.
Returns Promise<void>
- Defined in chatThreadClient.ts:388

sendMessage

sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResult>
Sends a chat message to a thread identified by threadId. Returns the id of the created message.
Parameters
- request: SendMessageRequest
  
  Request for sending a message.
- options: SendMessageOptions = {}
  
  Operation options.
Returns Promise<SendChatMessageResult>
- Defined in chatThreadClient.ts:137

sendReadReceipt

sendReadReceipt(request: SendReadReceiptRequest, options?: OperationOptions): Promise<void>
Sends a read receipt to the thread identified by threadId.
Parameters
- request: SendReadReceiptRequest
  
  Request for sending a read receipt
- options: OperationOptions = {}
  
  Operation options.
Returns Promise<void>
- Defined in chatThreadClient.ts:442

sendTypingNotification

sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>
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

Returns
True if the typing message notification could be sent, otherwise false.
Parameters
- options: SendTypingNotificationOptions = {}
  
  Operation options
Returns Promise<boolean>
- Defined in chatThreadClient.ts:411

updateMessage

updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<void>
Updates a message identified by threadId and messageId
Parameters
- messageId: string
  
  The message id of the message.
- options: UpdateMessageOptions = {}
  
  Operation options.
Returns Promise<void>
- Defined in chatThreadClient.ts:270

updateTopic

updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>
Updates a thread's topic.
Parameters
- topic: string
  
  The topic needs to be updated to.
- options: UpdateTopicOptions = {}
  
  Operation options.
Returns Promise<void>
- Defined in chatThreadClient.ts:117

Class ChatThreadClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

endpoint: string

threadId: string

credential: CommunicationTokenCredential

options: ChatThreadClientOptions = {}

Returns ChatThreadClient

Properties

Readonly threadId

Methods

addParticipants

Parameters

request: AddParticipantsRequest

options: OperationOptions = {}

Returns Promise<AddChatParticipantsResult>

deleteMessage

Parameters

messageId: string

options: OperationOptions = {}

Returns Promise<void>

getMessage

Parameters

messageId: string

options: OperationOptions = {}

Returns Promise<ChatMessage>

getProperties

Parameters

options: OperationOptions = {}

Returns Promise<ChatThreadProperties>

listMessages

Parameters

options: RestListMessagesOptions = {}

Returns PagedAsyncIterableIterator<ChatMessage>

listParticipants

Parameters

options: RestListParticipantsOptions = {}

Returns PagedAsyncIterableIterator<ChatParticipant>

listReadReceipts

Parameters

options: RestListReadReceiptsOptions = {}

Returns PagedAsyncIterableIterator<ChatMessageReadReceipt>

removeParticipant

Parameters

participant: CommunicationIdentifier

options: OperationOptions = {}

Returns Promise<void>

sendMessage

Parameters

request: SendMessageRequest

options: SendMessageOptions = {}

Returns Promise<SendChatMessageResult>

sendReadReceipt

Parameters

request: SendReadReceiptRequest

options: OperationOptions = {}

Returns Promise<void>

sendTypingNotification

Returns

Parameters

options: SendTypingNotificationOptions = {}

Returns Promise<boolean>

updateMessage

Parameters

messageId: string

options: UpdateMessageOptions = {}

Returns Promise<void>

updateTopic

Parameters

topic: string

options: UpdateTopicOptions = {}

Returns Promise<void>

Settings

Member Visibility

`Readonly` threadId