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: CommunicationUserCredential, options?: ChatThreadClientOptions): ChatThreadClient

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

Properties

threadId

threadId: string

Thread ID of the ChatThreadClient

Methods

addMembers

addMembers(request: AddMembersRequest, options?: AddMembersOptions): Promise<OperationResponse>

- Defined in chatThreadClient.ts:322
Adds the details of thread members belonging to the thread identified by threadId.

Parameters
- request: AddMembersRequest
  
  Thread members' details to add in the thread roster
- Default value options: AddMembersOptions = {}
  
  Operation options.
Returns Promise<OperationResponse>

deleteMessage

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

- Defined in chatThreadClient.ts:265
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:584
Dispose method.

Returns void

getMessage

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

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

listMembers

listMembers(options?: ListMembersOptions): PagedAsyncIterableIterator<ChatThreadMember>

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

Parameters
- Default value options: ListMembersOptions = {}
  
  Operation options.
Returns PagedAsyncIterableIterator<ChatThreadMember>

listMessages

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

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

listReadReceipts

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

- Defined in chatThreadClient.ts:552
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<ReadReceipt>

removeMember

removeMember(member: CommunicationUser, options?: RemoveMemberOptions): Promise<OperationResponse>

- Defined in chatThreadClient.ts:423
Removes member from the thread identified by threadId.

Parameters
- member: CommunicationUser
  
  Thread member to remove from the thread roster
- Default value options: RemoveMemberOptions = {}
  
  Operation options.
Returns Promise<OperationResponse>

sendMessage

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

- Defined in chatThreadClient.ts:137
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:488
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:452
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:293
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:111
Updates a thread's properties.

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

Generated using TypeDoc