Class ChatThreadClient

Package version

The client to do chat operations

Hierarchy

ChatThreadClient

Index

Constructors

constructor

Properties

threadId

Methods

Constructors

constructor

new ChatThreadClient(threadId: string, url: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions): ChatThreadClient

- Defined in chatThreadClient.ts:69
Parameters
- threadId: string
- url: string
- credential: CommunicationTokenCredential
- Default value options: ChatThreadClientOptions = {}
Returns ChatThreadClient

Properties

threadId

threadId: string

Thread ID of the ChatThreadClient

Methods

addParticipants

addParticipants(request: AddChatParticipantsRequest, options?: AddParticipantsOptions): Promise<AddChatParticipantsResult>

- Defined in chatThreadClient.ts:326
Adds the details of chat participants belonging to the thread identified by threadId.

Parameters
- request: AddChatParticipantsRequest
  
  Thread participants' details to add in the thread roster
- Default value options: AddParticipantsOptions = {}
  
  Operation options.
Returns Promise<AddChatParticipantsResult>

deleteMessage

deleteMessage(messageId: string, options?: DeleteMessageOptions): Promise<OperationResponse>

- Defined in chatThreadClient.ts:269
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<OperationResponse>

dispose

dispose(): void

- Defined in chatThreadClient.ts:591
Dispose method.

Returns void

getMessage

getMessage(messageId: string, options?: GetMessageOptions): Promise<GetChatMessageResponse>

- Defined in chatThreadClient.ts:170
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<GetChatMessageResponse>

listMessages

listMessages(options?: ListMessagesOptions): PagedAsyncIterableIterator<ChatMessage>

- Defined in chatThreadClient.ts:237
Gets a list of message from a thread identified by threadId. Returns the list of the messages.

Parameters
- Default value options: ListMessagesOptions = {}
  
  Get messages options.
Returns PagedAsyncIterableIterator<ChatMessage>

listParticipants

listParticipants(options?: ListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant>

- Defined in chatThreadClient.ts:393
Gets the participants of the thread identified by threadId. Returns the lists of the participants.

Parameters
- Default value options: ListParticipantsOptions = {}
  
  Operation options.
Returns PagedAsyncIterableIterator<ChatParticipant>

listReadReceipts

listReadReceipts(options?: ListReadReceiptsOptions): PagedAsyncIterableIterator<ChatMessageReadReceipt>

- Defined in chatThreadClient.ts:559
Gets a list of read receipt from a thread identified by threadId. Returns the list of the messages.

Parameters
- Default value options: ListReadReceiptsOptions = {}
  
  Get messages options.
Returns PagedAsyncIterableIterator<ChatMessageReadReceipt>

removeParticipant

removeParticipant(participant: CommunicationUserIdentifier, options?: RemoveParticipantOptions): Promise<OperationResponse>

- Defined in chatThreadClient.ts:427
Removes participant from the thread identified by threadId.

Parameters
- participant: CommunicationUserIdentifier
  
  Thread participant to remove from the thread roster
- Default value options: RemoveParticipantOptions = {}
  
  Operation options.
Returns Promise<OperationResponse>

sendMessage

sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResponse>

- Defined in chatThreadClient.ts:138
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.
- Default value options: SendMessageOptions = {}
  
  Operation options.
Returns Promise<SendChatMessageResponse>

sendReadReceipt

sendReadReceipt(request: SendReadReceiptRequest, options?: SendReadReceiptOptions): Promise<OperationResponse>

- Defined in chatThreadClient.ts:492
Sends a read receipt to the thread identified by threadId.

Parameters
- request: SendReadReceiptRequest
  
  Request for sending a read receipt
- Default value options: SendReadReceiptOptions = {}
  
  Operation options.
Returns Promise<OperationResponse>

sendTypingNotification

sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>

- Defined in chatThreadClient.ts:456
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
- Default value options: SendTypingNotificationOptions = {}
  - Operation options
Returns Promise<boolean>

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

updateMessage

updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<OperationResponse>

- Defined in chatThreadClient.ts:297
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<OperationResponse>

updateThread

updateThread(options?: UpdateThreadOptions): Promise<OperationResponse>

- Defined in chatThreadClient.ts:112
Updates a thread's properties.

Parameters
- Default value options: UpdateThreadOptions = {}
  
  Operation options.
Returns Promise<OperationResponse>

Generated using TypeDoc