Class ChatApiClient

Package version

Hierarchy

ChatApiClientContext
- ChatApiClient

Constructors

constructor

new ChatApiClient(endpoint: string, options?: ChatApiClientOptionalParams): ChatApiClient

Overrides ChatApiClientContext.constructor
- Defined in generated/src/chatApiClient.ts:40
Initializes a new instance of the ChatApiClient class.

Parameters
- endpoint: string
  
  The endpoint of the Azure Communication resource.
- Optional options: ChatApiClientOptionalParams
  
  The parameter options
Returns ChatApiClient

Properties

apiVersion

apiVersion: string

endpoint

endpoint: string

Methods

addChatThreadMembers

addChatThreadMembers(chatThreadId: string, body: AddChatThreadMembersRequest, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/chatApiClient.ts:230
Adds thread members to a thread. If members already exist, no change occurs.

Parameters
- chatThreadId: string
  
  Id of the thread to add members to.
- body: AddChatThreadMembersRequest
  
  Thread members to be added to the thread.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

createChatThread

createChatThread(body: CreateChatThreadRequest, options?: coreHttp.OperationOptions): Promise<ChatApiClientCreateChatThreadResponse>

- Defined in generated/src/chatApiClient.ts:269
Creates a chat thread.

Parameters
- body: CreateChatThreadRequest
  
  Request payload for creating a chat thread.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatApiClientCreateChatThreadResponse>

deleteChatMessage

deleteChatMessage(chatThreadId: string, chatMessageId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/chatApiClient.ts:174
Deletes a message.

Parameters
- chatThreadId: string
  
  The thread id to which the message was sent.
- chatMessageId: string
  
  The message id.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

deleteChatThread

deleteChatThread(chatThreadId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/chatApiClient.ts:341
Deletes a thread.

Parameters
- chatThreadId: string
  
  Thread id to delete.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

getChatMessage

getChatMessage(chatThreadId: string, chatMessageId: string, options?: coreHttp.OperationOptions): Promise<ChatApiClientGetChatMessageResponse>

- Defined in generated/src/chatApiClient.ts:132
Gets a message by id.

Parameters
- chatThreadId: string
  
  The thread id to which the message was sent.
- chatMessageId: string
  
  The message id.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatApiClientGetChatMessageResponse>

getChatThread

getChatThread(chatThreadId: string, options?: coreHttp.OperationOptions): Promise<ChatApiClientGetChatThreadResponse>

- Defined in generated/src/chatApiClient.ts:323
Gets a chat thread.

Parameters
- chatThreadId: string
  
  Thread id to get.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatApiClientGetChatThreadResponse>

listChatMessages

listChatMessages(chatThreadId: string, options?: ChatApiClientListChatMessagesOptionalParams): Promise<ChatApiClientListChatMessagesResponse>

- Defined in generated/src/chatApiClient.ts:113
Gets a list of messages from a thread.

Parameters
- chatThreadId: string
  
  The thread id of the message.
- Optional options: ChatApiClientListChatMessagesOptionalParams
  
  The options parameters.
Returns Promise<ChatApiClientListChatMessagesResponse>

listChatMessagesNext

listChatMessagesNext(chatThreadId: string, nextLink: string, options?: ChatApiClientListChatMessagesNextOptionalParams): Promise<ChatApiClientListChatMessagesNextResponse>

- Defined in generated/src/chatApiClient.ts:380
ListChatMessagesNext

Parameters
- chatThreadId: string
  
  The thread id of the message.
- nextLink: string
  
  The nextLink from the previous successful call to the ListChatMessages method.
- Optional options: ChatApiClientListChatMessagesNextOptionalParams
  
  The options parameters.
Returns Promise<ChatApiClientListChatMessagesNextResponse>

listChatReadReceipts

listChatReadReceipts(chatThreadId: string, options?: coreHttp.OperationOptions): Promise<ChatApiClientListChatReadReceiptsResponse>

- Defined in generated/src/chatApiClient.ts:55
Gets read receipts for a thread.

Parameters
- chatThreadId: string
  
  Thread id to get the read receipts for.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatApiClientListChatReadReceiptsResponse>

listChatReadReceiptsNext

listChatReadReceiptsNext(chatThreadId: string, nextLink: string, options?: coreHttp.OperationOptions): Promise<ChatApiClientListChatReadReceiptsNextResponse>

- Defined in generated/src/chatApiClient.ts:360
ListChatReadReceiptsNext

Parameters
- chatThreadId: string
  
  Thread id to get the read receipts for.
- nextLink: string
  
  The nextLink from the previous successful call to the ListChatReadReceipts method.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatApiClientListChatReadReceiptsNextResponse>

listChatThreadMembers

listChatThreadMembers(chatThreadId: string, options?: coreHttp.OperationOptions): Promise<ChatApiClientListChatThreadMembersResponse>

- Defined in generated/src/chatApiClient.ts:211
Gets the members of a thread.

Parameters
- chatThreadId: string
  
  Thread id to get members for.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatApiClientListChatThreadMembersResponse>

listChatThreadMembersNext

listChatThreadMembersNext(chatThreadId: string, nextLink: string, options?: coreHttp.OperationOptions): Promise<ChatApiClientListChatThreadMembersNextResponse>

- Defined in generated/src/chatApiClient.ts:400
ListChatThreadMembersNext

Parameters
- chatThreadId: string
  
  Thread id to get members for.
- nextLink: string
  
  The nextLink from the previous successful call to the ListChatThreadMembers method.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatApiClientListChatThreadMembersNextResponse>

listChatThreads

listChatThreads(options?: ChatApiClientListChatThreadsOptionalParams): Promise<ChatApiClientListChatThreadsResponse>

- Defined in generated/src/chatApiClient.ts:286
Gets the list of chat threads of a user.

Parameters
- Optional options: ChatApiClientListChatThreadsOptionalParams
  
  The options parameters.
Returns Promise<ChatApiClientListChatThreadsResponse>

listChatThreadsNext

listChatThreadsNext(nextLink: string, options?: ChatApiClientListChatThreadsNextOptionalParams): Promise<ChatApiClientListChatThreadsNextResponse>

- Defined in generated/src/chatApiClient.ts:419
ListChatThreadsNext

Parameters
- nextLink: string
  
  The nextLink from the previous successful call to the ListChatThreads method.
- Optional options: ChatApiClientListChatThreadsNextOptionalParams
  
  The options parameters.
Returns Promise<ChatApiClientListChatThreadsNextResponse>

removeChatThreadMember

removeChatThreadMember(chatThreadId: string, chatMemberId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/chatApiClient.ts:250
Remove a member from a thread.

Parameters
- chatThreadId: string
  
  Thread id to remove the member from.
- chatMemberId: string
  
  Id of the thread member to remove from the thread.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

sendChatMessage

sendChatMessage(chatThreadId: string, body: SendChatMessageRequest, options?: coreHttp.OperationOptions): Promise<ChatApiClientSendChatMessageResponse>

- Defined in generated/src/chatApiClient.ts:94
Sends a message to a thread.

Parameters
- chatThreadId: string
  
  The thread id to send the message to.
- body: SendChatMessageRequest
  
  Details of the message to send.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatApiClientSendChatMessageResponse>

sendChatReadReceipt

sendChatReadReceipt(chatThreadId: string, body: SendReadReceiptRequest, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/chatApiClient.ts:74
Sends a read receipt event to a thread, on behalf of a user.

Parameters
- chatThreadId: string
  
  Thread id to send the read receipt event to.
- body: SendReadReceiptRequest
  
  Read receipt details.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

sendTypingNotification

sendTypingNotification(chatThreadId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/chatApiClient.ts:193
Posts a typing event to a thread, on behalf of a user.

Parameters
- chatThreadId: string
  
  Id of the thread.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

updateChatMessage

updateChatMessage(chatThreadId: string, chatMessageId: string, body: UpdateChatMessageRequest, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/chatApiClient.ts:153
Updates a message.

Parameters
- chatThreadId: string
  
  The thread id to which the message was sent.
- chatMessageId: string
  
  The message id.
- body: UpdateChatMessageRequest
  
  Details of the request to update the message.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

updateChatThread

updateChatThread(chatThreadId: string, body: UpdateChatThreadRequest, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/chatApiClient.ts:304
Updates a thread's properties.

Parameters
- chatThreadId: string
  
  The id of the thread to update.
- body: UpdateChatThreadRequest
  
  Request payload for updating a chat thread.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

Generated using TypeDoc