@azure/communication-chat
Advanced tools
Comparing version 1.0.0-alpha.20210205.1 to 1.0.0-alpha.20210209.1
# Release History | ||
## 1.0.0-beta.4 (Unreleased) | ||
## 1.0.0-beta.4 (2021-02-09) | ||
@@ -9,3 +9,13 @@ ### Breaking Changes | ||
- Replaced `CommunicationUserCredential` with `CommunicationTokenCredential`. | ||
- Removed `priority` field (ChatMessage.Priority). | ||
### Added | ||
- Added support for `CreateChatThreadResult` and `AddChatParticipantsResult` to handle partial errors in batch calls. | ||
- Added idempotency identifier parameter for chat creation calls. | ||
- Added support for `listReadReceipts` and `listParticipants` pagination. | ||
- Added new model for messages an content types : `Text`, `Html`, `ParticipantAdded`, `ParticipantRemoved`, `TopicUpdated`. | ||
- Added new model for errors (`CommunicationError`) | ||
- Added notifications for thread level changes. | ||
## 1.0.0-beta.3 (2020-11-16) | ||
@@ -12,0 +22,0 @@ |
@@ -24,5 +24,5 @@ // Copyright (c) Microsoft Corporation. | ||
* | ||
* @param url The url of the Communication Services resouce. | ||
* @param credential The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential. | ||
* @param options Additional client options. | ||
* @param url - The url of the Communication Services resouce. | ||
* @param credential - The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential. | ||
* @param options - Additional client options. | ||
*/ | ||
@@ -59,3 +59,3 @@ constructor(url, credential, options = {}) { | ||
* Returns ChatThreadClient with the specific thread id. | ||
* @param threadId Thread ID for the ChatThreadClient | ||
* @param threadId - Thread ID for the ChatThreadClient | ||
*/ | ||
@@ -70,4 +70,4 @@ getChatThreadClient(threadId) { | ||
* Returns thread client with the id of the created thread. | ||
* @param request Request for creating a chat thread. | ||
* @param options Operation options. | ||
* @param request - Request for creating a chat thread. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -99,4 +99,4 @@ createChatThread(request, options = {}) { | ||
* Returns the chat thread. | ||
* @param threadId The ID of the thread to get. | ||
* @param options Operation options. | ||
* @param threadId - The ID of the thread to get. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -165,3 +165,3 @@ getChatThread(threadId, options = {}) { | ||
* Gets the list of chat threads of a user. | ||
* @param options List chat threads options. | ||
* @param options - List chat threads options. | ||
*/ | ||
@@ -197,4 +197,4 @@ listChatThreads(options = {}) { | ||
* Deletes a chat thread. | ||
* @param threadId The ID of the thread to delete. | ||
* @param options Operation options. | ||
* @param threadId - The ID of the thread to delete. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -284,4 +284,19 @@ deleteChatThread(threadId, options = {}) { | ||
}); | ||
this.signalingClient.on("chatThreadCreated", (payload) => { | ||
this.emitter.emit("chatThreadCreated", payload); | ||
}); | ||
this.signalingClient.on("chatThreadDeleted", (payload) => { | ||
this.emitter.emit("chatThreadDeleted", payload); | ||
}); | ||
this.signalingClient.on("chatThreadPropertiesUpdated", (payload) => { | ||
this.emitter.emit("chatThreadPropertiesUpdated", payload); | ||
}); | ||
this.signalingClient.on("participantsAdded", (payload) => { | ||
this.emitter.emit("participantsAdded", payload); | ||
}); | ||
this.signalingClient.on("participantsRemoved", (payload) => { | ||
this.emitter.emit("participantsRemoved", payload); | ||
}); | ||
} | ||
} | ||
//# sourceMappingURL=chatClient.js.map |
@@ -45,3 +45,3 @@ // Copyright (c) Microsoft Corporation. | ||
* Updates a thread's properties. | ||
* @param options Operation options. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -69,4 +69,4 @@ updateThread(options = {}) { | ||
* Returns the id of the created message. | ||
* @param request Request for sending a message. | ||
* @param options Operation options. | ||
* @param request - Request for sending a message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -96,4 +96,4 @@ sendMessage(request, options = {}) { | ||
* Returns the specific message.\ | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -163,3 +163,3 @@ getMessage(messageId, options = {}) { | ||
* Returns the list of the messages. | ||
* @param options Get messages options. | ||
* @param options - Get messages options. | ||
*/ | ||
@@ -195,4 +195,4 @@ listMessages(options = {}) { | ||
* Deletes a message identified by threadId and messageId | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -219,4 +219,4 @@ deleteMessage(messageId, options = {}) { | ||
* Updates a message identified by threadId and messageId | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -243,4 +243,4 @@ updateMessage(messageId, options = {}) { | ||
* Adds the details of chat participants belonging to the thread identified by threadId. | ||
* @param request Thread participants' details to add in the thread roster | ||
* @param options Operation options. | ||
* @param request - Thread participants' details to add in the thread roster | ||
* @param options - Operation options. | ||
*/ | ||
@@ -308,3 +308,3 @@ addParticipants(request, options = {}) { | ||
* Returns the lists of the participants. | ||
* @param options Operation options. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -340,4 +340,4 @@ listParticipants(options = {}) { | ||
* Removes participant from the thread identified by threadId. | ||
* @param participant Thread participant to remove from the thread roster | ||
* @param options Operation options. | ||
* @param participant - Thread participant to remove from the thread roster | ||
* @param options - Operation options. | ||
*/ | ||
@@ -365,3 +365,3 @@ removeParticipant(participant, options = {}) { | ||
* Doesn't attempt to send if the time since last notification is smaller than the minimum typing interval | ||
* @param options - Operation options | ||
* @param options - - Operation options | ||
* @returns True if the typing message notification could be sent, otherwise false. | ||
@@ -396,5 +396,5 @@ */ | ||
* Sends a read receipt to the thread identified by threadId. | ||
* @param messageId The message id of the message that user latest read. | ||
* @param request Request for sending a read receipt | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message that user latest read. | ||
* @param request - Request for sending a read receipt | ||
* @param options - Operation options. | ||
*/ | ||
@@ -462,3 +462,3 @@ sendReadReceipt(request, options = {}) { | ||
* Returns the list of the messages. | ||
* @param options Get messages options. | ||
* @param options - Get messages options. | ||
*/ | ||
@@ -465,0 +465,0 @@ listReadReceipts(options = {}) { |
@@ -7,3 +7,3 @@ // Copyright (c) Microsoft Corporation. | ||
* | ||
* @param credential The CommunicationTokenCredential implementation that can supply the user credential. | ||
* @param credential - The CommunicationTokenCredential implementation that can supply the user credential. | ||
*/ | ||
@@ -10,0 +10,0 @@ export const createCommunicationTokenCredentialPolicy = (credential) => { |
@@ -13,4 +13,4 @@ /* | ||
* Initializes a new instance of the ChatApiClient class. | ||
* @param endpoint The endpoint of the Azure Communication resource. | ||
* @param options The parameter options | ||
* @param endpoint - The endpoint of the Azure Communication resource. | ||
* @param options - The parameter options | ||
*/ | ||
@@ -17,0 +17,0 @@ constructor(endpoint, options) { |
@@ -14,4 +14,4 @@ /* | ||
* Initializes a new instance of the ChatApiClientContext class. | ||
* @param endpoint The endpoint of the Azure Communication resource. | ||
* @param options The parameter options | ||
* @param endpoint - The endpoint of the Azure Communication resource. | ||
* @param options - The parameter options | ||
*/ | ||
@@ -18,0 +18,0 @@ constructor(endpoint, options) { |
@@ -15,3 +15,3 @@ /* | ||
* Initialize a new instance of the class Chat class. | ||
* @param client Reference to the service client | ||
* @param client - Reference to the service client | ||
*/ | ||
@@ -23,4 +23,4 @@ constructor(client) { | ||
* Creates a chat thread. | ||
* @param createChatThreadRequest Request payload for creating a chat thread. | ||
* @param options The options parameters. | ||
* @param createChatThreadRequest - Request payload for creating a chat thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -36,3 +36,3 @@ createChatThread(createChatThreadRequest, options) { | ||
* Gets the list of chat threads of a user. | ||
* @param options The options parameters. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -47,4 +47,4 @@ listChatThreads(options) { | ||
* Gets a chat thread. | ||
* @param chatThreadId Id of the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -60,4 +60,4 @@ getChatThread(chatThreadId, options) { | ||
* Deletes a thread. | ||
* @param chatThreadId Id of the thread to be deleted. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread to be deleted. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -73,4 +73,4 @@ deleteChatThread(chatThreadId, options) { | ||
* ListChatThreadsNext | ||
* @param nextLink The nextLink from the previous successful call to the ListChatThreads method. | ||
* @param options The options parameters. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatThreads method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -77,0 +77,0 @@ listChatThreadsNext(nextLink, options) { |
@@ -15,3 +15,3 @@ /* | ||
* Initialize a new instance of the class ChatThread class. | ||
* @param client Reference to the service client | ||
* @param client - Reference to the service client | ||
*/ | ||
@@ -23,4 +23,4 @@ constructor(client) { | ||
* Gets chat message read receipts for a thread. | ||
* @param chatThreadId Thread id to get the chat message read receipts for. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get the chat message read receipts for. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -36,5 +36,5 @@ listChatReadReceipts(chatThreadId, options) { | ||
* Sends a read receipt event to a thread, on behalf of a user. | ||
* @param chatThreadId Thread id to send the read receipt event to. | ||
* @param sendReadReceiptRequest Read receipt details. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to send the read receipt event to. | ||
* @param sendReadReceiptRequest - Read receipt details. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -51,5 +51,5 @@ sendChatReadReceipt(chatThreadId, sendReadReceiptRequest, options) { | ||
* Sends a message to a thread. | ||
* @param chatThreadId The thread id to send the message to. | ||
* @param sendChatMessageRequest Details of the message to send. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to send the message to. | ||
* @param sendChatMessageRequest - Details of the message to send. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -66,4 +66,4 @@ sendChatMessage(chatThreadId, sendChatMessageRequest, options) { | ||
* Gets a list of messages from a thread. | ||
* @param chatThreadId The thread id of the message. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id of the message. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -79,5 +79,5 @@ listChatMessages(chatThreadId, options) { | ||
* Gets a message by id. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -94,6 +94,6 @@ getChatMessage(chatThreadId, chatMessageId, options) { | ||
* Updates a message. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param updateChatMessageRequest Details of the request to update the message. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param updateChatMessageRequest - Details of the request to update the message. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -111,5 +111,5 @@ updateChatMessage(chatThreadId, chatMessageId, updateChatMessageRequest, options) { | ||
* Deletes a message. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -126,4 +126,4 @@ deleteChatMessage(chatThreadId, chatMessageId, options) { | ||
* Posts a typing event to a thread, on behalf of a user. | ||
* @param chatThreadId Id of the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -139,4 +139,4 @@ sendTypingNotification(chatThreadId, options) { | ||
* Gets the participants of a thread. | ||
* @param chatThreadId Thread id to get participants for. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get participants for. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -152,5 +152,5 @@ listChatParticipants(chatThreadId, options) { | ||
* Remove a participant from a thread. | ||
* @param chatThreadId Thread id to remove the participant from. | ||
* @param chatParticipantId Id of the thread participant to remove from the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to remove the participant from. | ||
* @param chatParticipantId - Id of the thread participant to remove from the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -167,5 +167,5 @@ removeChatParticipant(chatThreadId, chatParticipantId, options) { | ||
* Adds thread participants to a thread. If participants already exist, no change occurs. | ||
* @param chatThreadId Id of the thread to add participants to. | ||
* @param addChatParticipantsRequest Thread participants to be added to the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread to add participants to. | ||
* @param addChatParticipantsRequest - Thread participants to be added to the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -182,5 +182,5 @@ addChatParticipants(chatThreadId, addChatParticipantsRequest, options) { | ||
* Updates a thread's properties. | ||
* @param chatThreadId The id of the thread to update. | ||
* @param updateChatThreadRequest Request payload for updating a chat thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The id of the thread to update. | ||
* @param updateChatThreadRequest - Request payload for updating a chat thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -197,5 +197,5 @@ updateChatThread(chatThreadId, updateChatThreadRequest, options) { | ||
* ListChatReadReceiptsNext | ||
* @param chatThreadId Thread id to get the chat message read receipts for. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatReadReceipts method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get the chat message read receipts for. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatReadReceipts method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -212,5 +212,5 @@ listChatReadReceiptsNext(chatThreadId, nextLink, options) { | ||
* ListChatMessagesNext | ||
* @param chatThreadId The thread id of the message. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatMessages method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id of the message. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatMessages method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -227,5 +227,5 @@ listChatMessagesNext(chatThreadId, nextLink, options) { | ||
* ListChatParticipantsNext | ||
* @param chatThreadId Thread id to get participants for. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatParticipants method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get participants for. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatParticipants method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -232,0 +232,0 @@ listChatParticipantsNext(chatThreadId, nextLink, options) { |
@@ -8,4 +8,4 @@ // Copyright (c) Microsoft Corporation. | ||
* @ignore | ||
* @param name The name of the operation being performed. | ||
* @param tracingOptions The options for the underlying http request. | ||
* @param name - The name of the operation being performed. | ||
* @param tracingOptions - The options for the underlying http request. | ||
*/ | ||
@@ -12,0 +12,0 @@ export function createSpan(operationName, operationOptions) { |
{ | ||
"name": "@azure/communication-chat", | ||
"version": "1.0.0-alpha.20210205.1", | ||
"version": "1.0.0-alpha.20210209.1", | ||
"description": "Azure client library for Azure Communication Chat services", | ||
@@ -5,0 +5,0 @@ "sdk-type": "client", |
@@ -23,3 +23,3 @@ # Azure Communication Chat client library for JavaScript | ||
A chat conversation is represented by a thread. Each user in the thread is called a thread member. Thread members can chat with one another privately in a 1:1 chat or huddle up in a 1:N group chat. Users also get near-real time updates for when others are typing and when they have read the messages. | ||
A chat conversation is represented by a thread. Each user in the thread is called a chat participant. Chat participants can chat with one another privately in a 1:1 chat or huddle up in a 1:N group chat. Users also get near-real time updates for when others are typing and when they have read the messages. | ||
@@ -32,3 +32,3 @@ ### ChatClient | ||
`ChatThreadClient` provides asynchronous methods to do the message and chat thread members operations within the chat thread. | ||
`ChatThreadClient` provides asynchronous methods to do the message and chat participants operations within the chat thread. | ||
@@ -57,14 +57,14 @@ ## Examples | ||
`createThreadRequest` is used to describe the thread request: | ||
`createChatThreadRequest` is used to describe the thread request: | ||
- Use `topic` to give a thread topic; | ||
- Use `members` to list the thread members to be added to the thread; | ||
- Use `participants` to list the chat participants to be added to the thread; | ||
`createThreadResult` is the response returned from creating a thread. It contains a `chatThread` which is the thread that was created, as well as an `errors` property which will contain information about invalid participants if they failed to be added to the thread. | ||
`createChatThreadResponse` is the response returned from creating a thread. It contains a `chatThread` which is the thread that was created, as well as an `errors` property which will contain information about invalid participants if they failed to be added to the thread. | ||
```Javascript | ||
let createThreadRequest = | ||
let createChatThreadRequest = | ||
{ | ||
topic: 'Preparation for London conference', | ||
members: | ||
participants: | ||
[ | ||
@@ -81,4 +81,4 @@ { | ||
}; | ||
let chatThreadResult = await chatClient.createChatThread(createThreadRequest); | ||
let threadId = chatThreadResult.chatThread.id; | ||
let createChatThreadResponse = await chatClient.createChatThread(createChatThreadRequest); | ||
let threadId = createChatThreadResponse.chatThread.id; | ||
``` | ||
@@ -96,6 +96,6 @@ | ||
- Use `priority` to specify the message priority level, such as 'Normal' or 'High' ; | ||
- Use `senderDisplayName` to specify the display name of the sender; | ||
- Use `type` to specify the message type, such as 'text' or 'html' ; | ||
`sendChatMessageResult` is the response returned from sending a message, it contains an ID, which is the unique ID of the message. | ||
`sendChatMessageResponse` is the response returned from sending a message, it contains an ID, which is the unique ID of the message. | ||
@@ -109,7 +109,7 @@ ```JavaScript | ||
{ | ||
priority: 'Normal', | ||
senderDisplayName : 'Jack' | ||
senderDisplayName : 'Jack', | ||
type: 'text' | ||
}; | ||
let sendChatMessageResult = await chatThreadClient.sendMessage(sendMessageRequest, sendMessageOptions); | ||
let messageId = sendChatMessageResult.id; | ||
let sendChatMessageResponse = await chatThreadClient.sendMessage(sendMessageRequest, sendMessageOptions); | ||
let messageId = sendChatMessageResponse.id; | ||
``` | ||
@@ -151,5 +151,5 @@ | ||
let addMembersRequest = | ||
let addChatParticipantsRequest = | ||
{ | ||
members: [ | ||
participants: [ | ||
{ | ||
@@ -163,3 +163,3 @@ user: { communicationUserId: userTokenResponse.identity }, | ||
await chatThreadClient.addMembers(addMembersRequest); | ||
await chatThreadClient.addParticipants(addChatParticipantsRequest); | ||
@@ -170,7 +170,7 @@ ``` | ||
Similar to above, you can also remove users from a thread. In order to remove, you will need to track the IDs of the members you have added. | ||
Similar to above, you can also remove users from a thread. In order to remove, you will need to track the IDs of the participants you have added. | ||
```JavaScript | ||
await chatThreadClient.removeMember({ communicationUserId: '<MEMBER_ID>' }); | ||
await chatThreadClient.removeParticipant({ communicationUserId: '<MEMBER_ID>' }); | ||
@@ -177,0 +177,0 @@ ``` |
@@ -16,3 +16,8 @@ // Copyright (c) Microsoft Corporation. | ||
ReadReceiptReceivedEvent, | ||
TypingIndicatorReceivedEvent | ||
TypingIndicatorReceivedEvent, | ||
ChatThreadCreatedEvent, | ||
ChatThreadDeletedEvent, | ||
ChatThreadPropertiesUpdatedEvent, | ||
ParticipantsAddedEvent, | ||
ParticipantsRemovedEvent | ||
} from "@azure/communication-signaling"; | ||
@@ -69,5 +74,5 @@ import { getSignalingClient } from "./signaling/signalingClient"; | ||
* | ||
* @param url The url of the Communication Services resouce. | ||
* @param credential The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential. | ||
* @param options Additional client options. | ||
* @param url - The url of the Communication Services resouce. | ||
* @param credential - The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential. | ||
* @param options - Additional client options. | ||
*/ | ||
@@ -114,3 +119,3 @@ constructor( | ||
* Returns ChatThreadClient with the specific thread id. | ||
* @param threadId Thread ID for the ChatThreadClient | ||
* @param threadId - Thread ID for the ChatThreadClient | ||
*/ | ||
@@ -124,4 +129,4 @@ public async getChatThreadClient(threadId: string): Promise<ChatThreadClient> { | ||
* Returns thread client with the id of the created thread. | ||
* @param request Request for creating a chat thread. | ||
* @param options Operation options. | ||
* @param request - Request for creating a chat thread. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -158,4 +163,4 @@ public async createChatThread( | ||
* Returns the chat thread. | ||
* @param threadId The ID of the thread to get. | ||
* @param options Operation options. | ||
* @param threadId - The ID of the thread to get. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -223,3 +228,3 @@ public async getChatThread( | ||
* Gets the list of chat threads of a user. | ||
* @param options List chat threads options. | ||
* @param options - List chat threads options. | ||
*/ | ||
@@ -256,4 +261,4 @@ public listChatThreads( | ||
* Deletes a chat thread. | ||
* @param threadId The ID of the thread to delete. | ||
* @param options Operation options. | ||
* @param threadId - The ID of the thread to delete. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -318,4 +323,4 @@ public async deleteChatThread( | ||
* You need to call startRealtimeNotifications before subscribing to any event. | ||
* @param event The ChatMessageReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -327,4 +332,4 @@ public on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The ChatMessageEditedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageEditedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -336,4 +341,4 @@ public on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The ChatMessageDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageDeletedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -345,4 +350,4 @@ public on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The TypingIndicatorReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The TypingIndicatorReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -356,7 +361,45 @@ public on( | ||
* Subscribe function for readReceiptReceived. | ||
* @param event The ReadReceiptReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ReadReceiptReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
public on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void; | ||
/** | ||
* Subscribe function for chatThreadCreated. | ||
* @param event The ChatThreadCreatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void): void; | ||
/** | ||
* Subscribe function for chatThreadDeleted. | ||
* @param event The ChatThreadDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void): void; | ||
/** | ||
* Subscribe function for chatThreadPropertiesUpdated. | ||
* @param event The ChatThreadPropertiesUpdatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public on( | ||
event: "chatThreadPropertiesUpdated", | ||
listener: (e: ChatThreadPropertiesUpdatedEvent) => void | ||
): void; | ||
/** | ||
* Subscribe function for participantsAdded. | ||
* @param event The ParticipantsAddedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void): void; | ||
/** | ||
* Subscribe function for participantsRemoved. | ||
* @param event The ParticipantsRemovedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void; | ||
public on(event: ChatEventId, listener: (e: any) => void): void { | ||
@@ -378,4 +421,4 @@ if (this.signalingClient === undefined) { | ||
* Unsubscribe from chatMessageReceived. | ||
* @param event The ChatMessageReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -386,4 +429,4 @@ public off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void; | ||
* Unsubscribe from chatMessageEdited. | ||
* @param event The ChatMessageEditedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageEditedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -394,4 +437,4 @@ public off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void; | ||
* Unsubscribe from chatMessageDeleted. | ||
* @param event The ChatMessageDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageDeletedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -402,4 +445,4 @@ public off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void; | ||
* Unsubscribe from typingIndicatorReceived. | ||
* @param event The TypingIndicatorReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The TypingIndicatorReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -413,7 +456,45 @@ public off( | ||
* Unsubscribe from readReceiptReceived. | ||
* @param event The ReadReceiptReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ReadReceiptReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
public off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadCreated. | ||
* @param event The ChatThreadCreatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadDeleted. | ||
* @param event The ChatThreadDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadPropertiesUpdated. | ||
* @param event The ChatThreadPropertiesUpdatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public off( | ||
event: "chatThreadPropertiesUpdated", | ||
listener: (e: ChatThreadPropertiesUpdatedEvent) => void | ||
): void; | ||
/** | ||
* Unsubscribe from participantsAdded. | ||
* @param event The ParticipantsAddedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void): void; | ||
/** | ||
* Unsubscribe from participantsRemoved. | ||
* @param event The ParticipantsRemovedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
public off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void; | ||
public off(event: ChatEventId, listener: (e: any) => void): void { | ||
@@ -451,3 +532,23 @@ if (this.signalingClient === undefined) { | ||
}); | ||
this.signalingClient.on("chatThreadCreated", (payload) => { | ||
this.emitter.emit("chatThreadCreated", payload); | ||
}); | ||
this.signalingClient.on("chatThreadDeleted", (payload) => { | ||
this.emitter.emit("chatThreadDeleted", payload); | ||
}); | ||
this.signalingClient.on("chatThreadPropertiesUpdated", (payload) => { | ||
this.emitter.emit("chatThreadPropertiesUpdated", payload); | ||
}); | ||
this.signalingClient.on("participantsAdded", (payload) => { | ||
this.emitter.emit("participantsAdded", payload); | ||
}); | ||
this.signalingClient.on("participantsRemoved", (payload) => { | ||
this.emitter.emit("participantsRemoved", payload); | ||
}); | ||
} | ||
} |
@@ -110,3 +110,3 @@ // Copyright (c) Microsoft Corporation. | ||
* Updates a thread's properties. | ||
* @param options Operation options. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -136,4 +136,4 @@ public async updateThread(options: UpdateThreadOptions = {}): Promise<OperationResponse> { | ||
* Returns the id of the created message. | ||
* @param request Request for sending a message. | ||
* @param options Operation options. | ||
* @param request - Request for sending a message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -169,4 +169,4 @@ public async sendMessage( | ||
* Returns the specific message.\ | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -238,3 +238,3 @@ public async getMessage( | ||
* Returns the list of the messages. | ||
* @param options Get messages options. | ||
* @param options - Get messages options. | ||
*/ | ||
@@ -270,4 +270,4 @@ public listMessages(options: ListMessagesOptions = {}): PagedAsyncIterableIterator<ChatMessage> { | ||
* Deletes a message identified by threadId and messageId | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -299,4 +299,4 @@ public async deleteMessage( | ||
* Updates a message identified by threadId and messageId | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -329,4 +329,4 @@ public async updateMessage( | ||
* Adds the details of chat participants belonging to the thread identified by threadId. | ||
* @param request Thread participants' details to add in the thread roster | ||
* @param options Operation options. | ||
* @param request - Thread participants' details to add in the thread roster | ||
* @param options - Operation options. | ||
*/ | ||
@@ -398,3 +398,3 @@ public async addParticipants( | ||
* Returns the lists of the participants. | ||
* @param options Operation options. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -432,4 +432,4 @@ public listParticipants( | ||
* Removes participant from the thread identified by threadId. | ||
* @param participant Thread participant to remove from the thread roster | ||
* @param options Operation options. | ||
* @param participant - Thread participant to remove from the thread roster | ||
* @param options - Operation options. | ||
*/ | ||
@@ -462,3 +462,3 @@ public async removeParticipant( | ||
* Doesn't attempt to send if the time since last notification is smaller than the minimum typing interval | ||
* @param options - Operation options | ||
* @param options - - Operation options | ||
* @returns True if the typing message notification could be sent, otherwise false. | ||
@@ -498,5 +498,5 @@ */ | ||
* Sends a read receipt to the thread identified by threadId. | ||
* @param messageId The message id of the message that user latest read. | ||
* @param request Request for sending a read receipt | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message that user latest read. | ||
* @param request - Request for sending a read receipt | ||
* @param options - Operation options. | ||
*/ | ||
@@ -568,3 +568,3 @@ public async sendReadReceipt( | ||
* Returns the list of the messages. | ||
* @param options Get messages options. | ||
* @param options - Get messages options. | ||
*/ | ||
@@ -571,0 +571,0 @@ public listReadReceipts( |
@@ -10,3 +10,3 @@ // Copyright (c) Microsoft Corporation. | ||
* | ||
* @param credential The CommunicationTokenCredential implementation that can supply the user credential. | ||
* @param credential - The CommunicationTokenCredential implementation that can supply the user credential. | ||
*/ | ||
@@ -13,0 +13,0 @@ export const createCommunicationTokenCredentialPolicy = ( |
@@ -16,4 +16,4 @@ /* | ||
* Initializes a new instance of the ChatApiClient class. | ||
* @param endpoint The endpoint of the Azure Communication resource. | ||
* @param options The parameter options | ||
* @param endpoint - The endpoint of the Azure Communication resource. | ||
* @param options - The parameter options | ||
*/ | ||
@@ -20,0 +20,0 @@ constructor(endpoint: string, options?: ChatApiClientOptionalParams) { |
@@ -21,4 +21,4 @@ /* | ||
* Initializes a new instance of the ChatApiClientContext class. | ||
* @param endpoint The endpoint of the Azure Communication resource. | ||
* @param options The parameter options | ||
* @param endpoint - The endpoint of the Azure Communication resource. | ||
* @param options - The parameter options | ||
*/ | ||
@@ -25,0 +25,0 @@ constructor(endpoint: string, options?: ChatApiClientOptionalParams) { |
@@ -30,3 +30,3 @@ /* | ||
* Initialize a new instance of the class Chat class. | ||
* @param client Reference to the service client | ||
* @param client - Reference to the service client | ||
*/ | ||
@@ -39,4 +39,4 @@ constructor(client: ChatApiClient) { | ||
* Creates a chat thread. | ||
* @param createChatThreadRequest Request payload for creating a chat thread. | ||
* @param options The options parameters. | ||
* @param createChatThreadRequest - Request payload for creating a chat thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -59,3 +59,3 @@ createChatThread( | ||
* Gets the list of chat threads of a user. | ||
* @param options The options parameters. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -76,4 +76,4 @@ listChatThreads( | ||
* Gets a chat thread. | ||
* @param chatThreadId Id of the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -96,4 +96,4 @@ getChatThread( | ||
* Deletes a thread. | ||
* @param chatThreadId Id of the thread to be deleted. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread to be deleted. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -116,4 +116,4 @@ deleteChatThread( | ||
* ListChatThreadsNext | ||
* @param nextLink The nextLink from the previous successful call to the ListChatThreads method. | ||
* @param options The options parameters. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatThreads method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -120,0 +120,0 @@ listChatThreadsNext( |
@@ -42,3 +42,3 @@ /* | ||
* Initialize a new instance of the class ChatThread class. | ||
* @param client Reference to the service client | ||
* @param client - Reference to the service client | ||
*/ | ||
@@ -51,4 +51,4 @@ constructor(client: ChatApiClient) { | ||
* Gets chat message read receipts for a thread. | ||
* @param chatThreadId Thread id to get the chat message read receipts for. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get the chat message read receipts for. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -71,5 +71,5 @@ listChatReadReceipts( | ||
* Sends a read receipt event to a thread, on behalf of a user. | ||
* @param chatThreadId Thread id to send the read receipt event to. | ||
* @param sendReadReceiptRequest Read receipt details. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to send the read receipt event to. | ||
* @param sendReadReceiptRequest - Read receipt details. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -94,5 +94,5 @@ sendChatReadReceipt( | ||
* Sends a message to a thread. | ||
* @param chatThreadId The thread id to send the message to. | ||
* @param sendChatMessageRequest Details of the message to send. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to send the message to. | ||
* @param sendChatMessageRequest - Details of the message to send. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -117,4 +117,4 @@ sendChatMessage( | ||
* Gets a list of messages from a thread. | ||
* @param chatThreadId The thread id of the message. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id of the message. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -137,5 +137,5 @@ listChatMessages( | ||
* Gets a message by id. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -160,6 +160,6 @@ getChatMessage( | ||
* Updates a message. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param updateChatMessageRequest Details of the request to update the message. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param updateChatMessageRequest - Details of the request to update the message. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -186,5 +186,5 @@ updateChatMessage( | ||
* Deletes a message. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -209,4 +209,4 @@ deleteChatMessage( | ||
* Posts a typing event to a thread, on behalf of a user. | ||
* @param chatThreadId Id of the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -229,4 +229,4 @@ sendTypingNotification( | ||
* Gets the participants of a thread. | ||
* @param chatThreadId Thread id to get participants for. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get participants for. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -249,5 +249,5 @@ listChatParticipants( | ||
* Remove a participant from a thread. | ||
* @param chatThreadId Thread id to remove the participant from. | ||
* @param chatParticipantId Id of the thread participant to remove from the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to remove the participant from. | ||
* @param chatParticipantId - Id of the thread participant to remove from the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -272,5 +272,5 @@ removeChatParticipant( | ||
* Adds thread participants to a thread. If participants already exist, no change occurs. | ||
* @param chatThreadId Id of the thread to add participants to. | ||
* @param addChatParticipantsRequest Thread participants to be added to the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread to add participants to. | ||
* @param addChatParticipantsRequest - Thread participants to be added to the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -295,5 +295,5 @@ addChatParticipants( | ||
* Updates a thread's properties. | ||
* @param chatThreadId The id of the thread to update. | ||
* @param updateChatThreadRequest Request payload for updating a chat thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The id of the thread to update. | ||
* @param updateChatThreadRequest - Request payload for updating a chat thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -318,5 +318,5 @@ updateChatThread( | ||
* ListChatReadReceiptsNext | ||
* @param chatThreadId Thread id to get the chat message read receipts for. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatReadReceipts method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get the chat message read receipts for. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatReadReceipts method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -341,5 +341,5 @@ listChatReadReceiptsNext( | ||
* ListChatMessagesNext | ||
* @param chatThreadId The thread id of the message. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatMessages method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id of the message. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatMessages method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -364,5 +364,5 @@ listChatMessagesNext( | ||
* ListChatParticipantsNext | ||
* @param chatThreadId Thread id to get participants for. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatParticipants method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get participants for. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatParticipants method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -369,0 +369,0 @@ listChatParticipantsNext( |
@@ -16,3 +16,3 @@ // Copyright (c) Microsoft Corporation. | ||
export interface SendMessageRequest | ||
extends Omit<RestSendMessageRequest, "priority" | "senderDisplayName"> {} | ||
extends Omit<RestSendMessageRequest, "type" | "senderDisplayName"> {} | ||
@@ -19,0 +19,0 @@ /** |
@@ -13,4 +13,4 @@ // Copyright (c) Microsoft Corporation. | ||
* @ignore | ||
* @param name The name of the operation being performed. | ||
* @param tracingOptions The options for the underlying http request. | ||
* @param name - The name of the operation being performed. | ||
* @param tracingOptions - The options for the underlying http request. | ||
*/ | ||
@@ -17,0 +17,0 @@ export function createSpan<T extends OperationOptions>( |
@@ -5,2 +5,5 @@ /// <reference lib="esnext.asynciterable" /> | ||
import { ChatMessageReceivedEvent } from '@azure/communication-signaling'; | ||
import { ChatThreadCreatedEvent } from '@azure/communication-signaling'; | ||
import { ChatThreadDeletedEvent } from '@azure/communication-signaling'; | ||
import { ChatThreadPropertiesUpdatedEvent } from '@azure/communication-signaling'; | ||
import { CommunicationTokenCredential } from '@azure/communication-common'; | ||
@@ -12,2 +15,4 @@ import { CommunicationUserIdentifier } from '@azure/communication-common'; | ||
import { PagedAsyncIterableIterator } from '@azure/core-paging'; | ||
import { ParticipantsAddedEvent } from '@azure/communication-signaling'; | ||
import { ParticipantsRemovedEvent } from '@azure/communication-signaling'; | ||
import { PipelineOptions } from '@azure/core-http'; | ||
@@ -63,5 +68,5 @@ import { ReadReceiptReceivedEvent } from '@azure/communication-signaling'; | ||
* | ||
* @param url The url of the Communication Services resouce. | ||
* @param credential The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential. | ||
* @param options Additional client options. | ||
* @param url - The url of the Communication Services resouce. | ||
* @param credential - The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential. | ||
* @param options - Additional client options. | ||
*/ | ||
@@ -71,3 +76,3 @@ constructor(url: string, credential: CommunicationTokenCredential, options?: ChatClientOptions); | ||
* Returns ChatThreadClient with the specific thread id. | ||
* @param threadId Thread ID for the ChatThreadClient | ||
* @param threadId - Thread ID for the ChatThreadClient | ||
*/ | ||
@@ -78,4 +83,4 @@ getChatThreadClient(threadId: string): Promise<ChatThreadClient>; | ||
* Returns thread client with the id of the created thread. | ||
* @param request Request for creating a chat thread. | ||
* @param options Operation options. | ||
* @param request - Request for creating a chat thread. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -86,4 +91,4 @@ createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResponse>; | ||
* Returns the chat thread. | ||
* @param threadId The ID of the thread to get. | ||
* @param options Operation options. | ||
* @param threadId - The ID of the thread to get. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -95,3 +100,3 @@ getChatThread(threadId: string, options?: GetChatThreadOptions): Promise<GetChatThreadResponse>; | ||
* Gets the list of chat threads of a user. | ||
* @param options List chat threads options. | ||
* @param options - List chat threads options. | ||
*/ | ||
@@ -101,4 +106,4 @@ listChatThreads(options?: ListChatThreadsOptions): PagedAsyncIterableIterator<ChatThreadInfo>; | ||
* Deletes a chat thread. | ||
* @param threadId The ID of the thread to delete. | ||
* @param options Operation options. | ||
* @param threadId - The ID of the thread to delete. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -120,4 +125,4 @@ deleteChatThread(threadId: string, options?: DeleteChatThreadOptions): Promise<OperationResponse>; | ||
* You need to call startRealtimeNotifications before subscribing to any event. | ||
* @param event The ChatMessageReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -128,4 +133,4 @@ on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The ChatMessageEditedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageEditedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -136,4 +141,4 @@ on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The ChatMessageDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageDeletedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -144,4 +149,4 @@ on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The TypingIndicatorReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The TypingIndicatorReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -151,16 +156,46 @@ on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void): void; | ||
* Subscribe function for readReceiptReceived. | ||
* @param event The ReadReceiptReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ReadReceiptReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatMessageReceived. | ||
* @param event The ChatMessageReceivedEvent. | ||
* Subscribe function for chatThreadCreated. | ||
* @param event The ChatThreadCreatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void): void; | ||
/** | ||
* Subscribe function for chatThreadDeleted. | ||
* @param event The ChatThreadDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void): void; | ||
/** | ||
* Subscribe function for chatThreadPropertiesUpdated. | ||
* @param event The ChatThreadPropertiesUpdatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void): void; | ||
/** | ||
* Subscribe function for participantsAdded. | ||
* @param event The ParticipantsAddedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void): void; | ||
/** | ||
* Subscribe function for participantsRemoved. | ||
* @param event The ParticipantsRemovedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatMessageReceived. | ||
* @param event - The ChatMessageReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatMessageEdited. | ||
* @param event The ChatMessageEditedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageEditedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -170,4 +205,4 @@ off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void; | ||
* Unsubscribe from chatMessageDeleted. | ||
* @param event The ChatMessageDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageDeletedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -177,4 +212,4 @@ off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void; | ||
* Unsubscribe from typingIndicatorReceived. | ||
* @param event The TypingIndicatorReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The TypingIndicatorReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -184,6 +219,36 @@ off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void): void; | ||
* Unsubscribe from readReceiptReceived. | ||
* @param event The ReadReceiptReceivedEvent. | ||
* @param event - The ReadReceiptReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadCreated. | ||
* @param event The ChatThreadCreatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void; | ||
off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadDeleted. | ||
* @param event The ChatThreadDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadPropertiesUpdated. | ||
* @param event The ChatThreadPropertiesUpdatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void): void; | ||
/** | ||
* Unsubscribe from participantsAdded. | ||
* @param event The ParticipantsAddedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void): void; | ||
/** | ||
* Unsubscribe from participantsRemoved. | ||
* @param event The ParticipantsRemovedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void; | ||
private subscribeToSignalingEvents; | ||
@@ -278,3 +343,3 @@ } | ||
* Updates a thread's properties. | ||
* @param options Operation options. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -285,4 +350,4 @@ updateThread(options?: UpdateThreadOptions): Promise<OperationResponse>; | ||
* Returns the id of the created message. | ||
* @param request Request for sending a message. | ||
* @param options Operation options. | ||
* @param request - Request for sending a message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -293,4 +358,4 @@ sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResponse>; | ||
* Returns the specific message.\ | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -303,3 +368,3 @@ getMessage(messageId: string, options?: GetMessageOptions): Promise<GetChatMessageResponse>; | ||
* Returns the list of the messages. | ||
* @param options Get messages options. | ||
* @param options - Get messages options. | ||
*/ | ||
@@ -309,4 +374,4 @@ listMessages(options?: ListMessagesOptions): PagedAsyncIterableIterator<ChatMessage>; | ||
* Deletes a message identified by threadId and messageId | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -316,4 +381,4 @@ deleteMessage(messageId: string, options?: DeleteMessageOptions): Promise<OperationResponse>; | ||
* Updates a message identified by threadId and messageId | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -323,4 +388,4 @@ updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<OperationResponse>; | ||
* Adds the details of chat participants belonging to the thread identified by threadId. | ||
* @param request Thread participants' details to add in the thread roster | ||
* @param options Operation options. | ||
* @param request - Thread participants' details to add in the thread roster | ||
* @param options - Operation options. | ||
*/ | ||
@@ -333,3 +398,3 @@ addParticipants(request: AddChatParticipantsRequest, options?: AddParticipantsOptions): Promise<AddChatParticipantsResult>; | ||
* Returns the lists of the participants. | ||
* @param options Operation options. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -339,4 +404,4 @@ listParticipants(options?: ListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant>; | ||
* Removes participant from the thread identified by threadId. | ||
* @param participant Thread participant to remove from the thread roster | ||
* @param options Operation options. | ||
* @param participant - Thread participant to remove from the thread roster | ||
* @param options - Operation options. | ||
*/ | ||
@@ -347,3 +412,3 @@ removeParticipant(participant: CommunicationUserIdentifier, options?: RemoveParticipantOptions): Promise<OperationResponse>; | ||
* Doesn't attempt to send if the time since last notification is smaller than the minimum typing interval | ||
* @param options - Operation options | ||
* @param options - - Operation options | ||
* @returns True if the typing message notification could be sent, otherwise false. | ||
@@ -354,5 +419,5 @@ */ | ||
* Sends a read receipt to the thread identified by threadId. | ||
* @param messageId The message id of the message that user latest read. | ||
* @param request Request for sending a read receipt | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message that user latest read. | ||
* @param request - Request for sending a read receipt | ||
* @param options - Operation options. | ||
*/ | ||
@@ -365,3 +430,3 @@ sendReadReceipt(request: SendReadReceiptRequest, options?: SendReadReceiptOptions): Promise<OperationResponse>; | ||
* Returns the list of the messages. | ||
* @param options Get messages options. | ||
* @param options - Get messages options. | ||
*/ | ||
@@ -699,3 +764,3 @@ listReadReceipts(options?: ListReadReceiptsOptions): PagedAsyncIterableIterator<ChatMessageReadReceipt>; | ||
*/ | ||
export declare interface SendMessageRequest extends Omit<SendChatMessageRequest, "priority" | "senderDisplayName"> { | ||
export declare interface SendMessageRequest extends Omit<SendChatMessageRequest, "type" | "senderDisplayName"> { | ||
} | ||
@@ -702,0 +767,0 @@ |
/// <reference lib="esnext.asynciterable" /> | ||
import { CommunicationTokenCredential } from "@azure/communication-common"; | ||
import { ChatMessageReceivedEvent, ChatMessageEditedEvent, ChatMessageDeletedEvent, ReadReceiptReceivedEvent, TypingIndicatorReceivedEvent } from "@azure/communication-signaling"; | ||
import { ChatMessageReceivedEvent, ChatMessageEditedEvent, ChatMessageDeletedEvent, ReadReceiptReceivedEvent, TypingIndicatorReceivedEvent, ChatThreadCreatedEvent, ChatThreadDeletedEvent, ChatThreadPropertiesUpdatedEvent, ParticipantsAddedEvent, ParticipantsRemovedEvent } from "@azure/communication-signaling"; | ||
import "@azure/core-paging"; | ||
@@ -26,5 +26,5 @@ import { PagedAsyncIterableIterator } from "@azure/core-paging"; | ||
* | ||
* @param url The url of the Communication Services resouce. | ||
* @param credential The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential. | ||
* @param options Additional client options. | ||
* @param url - The url of the Communication Services resouce. | ||
* @param credential - The token credential. Use AzureCommunicationTokenCredential from @azure/communication-common to create a credential. | ||
* @param options - Additional client options. | ||
*/ | ||
@@ -34,3 +34,3 @@ constructor(url: string, credential: CommunicationTokenCredential, options?: ChatClientOptions); | ||
* Returns ChatThreadClient with the specific thread id. | ||
* @param threadId Thread ID for the ChatThreadClient | ||
* @param threadId - Thread ID for the ChatThreadClient | ||
*/ | ||
@@ -41,4 +41,4 @@ getChatThreadClient(threadId: string): Promise<ChatThreadClient>; | ||
* Returns thread client with the id of the created thread. | ||
* @param request Request for creating a chat thread. | ||
* @param options Operation options. | ||
* @param request - Request for creating a chat thread. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -49,4 +49,4 @@ createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResponse>; | ||
* Returns the chat thread. | ||
* @param threadId The ID of the thread to get. | ||
* @param options Operation options. | ||
* @param threadId - The ID of the thread to get. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -58,3 +58,3 @@ getChatThread(threadId: string, options?: GetChatThreadOptions): Promise<GetChatThreadResponse>; | ||
* Gets the list of chat threads of a user. | ||
* @param options List chat threads options. | ||
* @param options - List chat threads options. | ||
*/ | ||
@@ -64,4 +64,4 @@ listChatThreads(options?: ListChatThreadsOptions): PagedAsyncIterableIterator<ChatThreadInfo>; | ||
* Deletes a chat thread. | ||
* @param threadId The ID of the thread to delete. | ||
* @param options Operation options. | ||
* @param threadId - The ID of the thread to delete. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -83,4 +83,4 @@ deleteChatThread(threadId: string, options?: DeleteChatThreadOptions): Promise<OperationResponse>; | ||
* You need to call startRealtimeNotifications before subscribing to any event. | ||
* @param event The ChatMessageReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -91,4 +91,4 @@ on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The ChatMessageEditedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageEditedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -99,4 +99,4 @@ on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The ChatMessageDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageDeletedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -107,4 +107,4 @@ on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void; | ||
* The initial sender will also receive this event. | ||
* @param event The TypingIndicatorReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The TypingIndicatorReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -114,16 +114,46 @@ on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void): void; | ||
* Subscribe function for readReceiptReceived. | ||
* @param event The ReadReceiptReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ReadReceiptReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatMessageReceived. | ||
* @param event The ChatMessageReceivedEvent. | ||
* Subscribe function for chatThreadCreated. | ||
* @param event The ChatThreadCreatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void): void; | ||
/** | ||
* Subscribe function for chatThreadDeleted. | ||
* @param event The ChatThreadDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void): void; | ||
/** | ||
* Subscribe function for chatThreadPropertiesUpdated. | ||
* @param event The ChatThreadPropertiesUpdatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void): void; | ||
/** | ||
* Subscribe function for participantsAdded. | ||
* @param event The ParticipantsAddedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void): void; | ||
/** | ||
* Subscribe function for participantsRemoved. | ||
* @param event The ParticipantsRemovedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatMessageReceived. | ||
* @param event - The ChatMessageReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatMessageEdited. | ||
* @param event The ChatMessageEditedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageEditedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -133,4 +163,4 @@ off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void; | ||
* Unsubscribe from chatMessageDeleted. | ||
* @param event The ChatMessageDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The ChatMessageDeletedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -140,4 +170,4 @@ off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void; | ||
* Unsubscribe from typingIndicatorReceived. | ||
* @param event The TypingIndicatorReceivedEvent. | ||
* @param listener The listener to handle the event. | ||
* @param event - The TypingIndicatorReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
@@ -147,8 +177,38 @@ off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void): void; | ||
* Unsubscribe from readReceiptReceived. | ||
* @param event The ReadReceiptReceivedEvent. | ||
* @param event - The ReadReceiptReceivedEvent. | ||
* @param listener - The listener to handle the event. | ||
*/ | ||
off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadCreated. | ||
* @param event The ChatThreadCreatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void; | ||
off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadDeleted. | ||
* @param event The ChatThreadDeletedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void): void; | ||
/** | ||
* Unsubscribe from chatThreadPropertiesUpdated. | ||
* @param event The ChatThreadPropertiesUpdatedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void): void; | ||
/** | ||
* Unsubscribe from participantsAdded. | ||
* @param event The ParticipantsAddedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void): void; | ||
/** | ||
* Unsubscribe from participantsRemoved. | ||
* @param event The ParticipantsRemovedEvent. | ||
* @param listener The listener to handle the event. | ||
*/ | ||
off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void): void; | ||
private subscribeToSignalingEvents; | ||
} | ||
//# sourceMappingURL=chatClient.d.ts.map |
@@ -25,3 +25,3 @@ import { CommunicationUserIdentifier, CommunicationTokenCredential } from "@azure/communication-common"; | ||
* Updates a thread's properties. | ||
* @param options Operation options. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -32,4 +32,4 @@ updateThread(options?: UpdateThreadOptions): Promise<OperationResponse>; | ||
* Returns the id of the created message. | ||
* @param request Request for sending a message. | ||
* @param options Operation options. | ||
* @param request - Request for sending a message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -40,4 +40,4 @@ sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResponse>; | ||
* Returns the specific message.\ | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -50,3 +50,3 @@ getMessage(messageId: string, options?: GetMessageOptions): Promise<GetChatMessageResponse>; | ||
* Returns the list of the messages. | ||
* @param options Get messages options. | ||
* @param options - Get messages options. | ||
*/ | ||
@@ -56,4 +56,4 @@ listMessages(options?: ListMessagesOptions): PagedAsyncIterableIterator<ChatMessage>; | ||
* Deletes a message identified by threadId and messageId | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -63,4 +63,4 @@ deleteMessage(messageId: string, options?: DeleteMessageOptions): Promise<OperationResponse>; | ||
* Updates a message identified by threadId and messageId | ||
* @param messageId The message id of the message. | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -70,4 +70,4 @@ updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<OperationResponse>; | ||
* Adds the details of chat participants belonging to the thread identified by threadId. | ||
* @param request Thread participants' details to add in the thread roster | ||
* @param options Operation options. | ||
* @param request - Thread participants' details to add in the thread roster | ||
* @param options - Operation options. | ||
*/ | ||
@@ -80,3 +80,3 @@ addParticipants(request: AddChatParticipantsRequest, options?: AddParticipantsOptions): Promise<AddChatParticipantsResult>; | ||
* Returns the lists of the participants. | ||
* @param options Operation options. | ||
* @param options - Operation options. | ||
*/ | ||
@@ -86,4 +86,4 @@ listParticipants(options?: ListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant>; | ||
* Removes participant from the thread identified by threadId. | ||
* @param participant Thread participant to remove from the thread roster | ||
* @param options Operation options. | ||
* @param participant - Thread participant to remove from the thread roster | ||
* @param options - Operation options. | ||
*/ | ||
@@ -94,3 +94,3 @@ removeParticipant(participant: CommunicationUserIdentifier, options?: RemoveParticipantOptions): Promise<OperationResponse>; | ||
* Doesn't attempt to send if the time since last notification is smaller than the minimum typing interval | ||
* @param options - Operation options | ||
* @param options - - Operation options | ||
* @returns True if the typing message notification could be sent, otherwise false. | ||
@@ -101,5 +101,5 @@ */ | ||
* Sends a read receipt to the thread identified by threadId. | ||
* @param messageId The message id of the message that user latest read. | ||
* @param request Request for sending a read receipt | ||
* @param options Operation options. | ||
* @param messageId - The message id of the message that user latest read. | ||
* @param request - Request for sending a read receipt | ||
* @param options - Operation options. | ||
*/ | ||
@@ -112,3 +112,3 @@ sendReadReceipt(request: SendReadReceiptRequest, options?: SendReadReceiptOptions): Promise<OperationResponse>; | ||
* Returns the list of the messages. | ||
* @param options Get messages options. | ||
* @param options - Get messages options. | ||
*/ | ||
@@ -115,0 +115,0 @@ listReadReceipts(options?: ListReadReceiptsOptions): PagedAsyncIterableIterator<ChatMessageReadReceipt>; |
@@ -6,5 +6,5 @@ import { CommunicationTokenCredential } from "@azure/communication-common"; | ||
* | ||
* @param credential The CommunicationTokenCredential implementation that can supply the user credential. | ||
* @param credential - The CommunicationTokenCredential implementation that can supply the user credential. | ||
*/ | ||
export declare const createCommunicationTokenCredentialPolicy: (credential: CommunicationTokenCredential) => RequestPolicyFactory; | ||
//# sourceMappingURL=communicationTokenCredentialPolicy.d.ts.map |
@@ -7,4 +7,4 @@ import { ChatThread, Chat } from "./operations"; | ||
* Initializes a new instance of the ChatApiClient class. | ||
* @param endpoint The endpoint of the Azure Communication resource. | ||
* @param options The parameter options | ||
* @param endpoint - The endpoint of the Azure Communication resource. | ||
* @param options - The parameter options | ||
*/ | ||
@@ -11,0 +11,0 @@ constructor(endpoint: string, options?: ChatApiClientOptionalParams); |
@@ -8,4 +8,4 @@ import * as coreHttp from "@azure/core-http"; | ||
* Initializes a new instance of the ChatApiClientContext class. | ||
* @param endpoint The endpoint of the Azure Communication resource. | ||
* @param options The parameter options | ||
* @param endpoint - The endpoint of the Azure Communication resource. | ||
* @param options - The parameter options | ||
*/ | ||
@@ -12,0 +12,0 @@ constructor(endpoint: string, options?: ChatApiClientOptionalParams); |
@@ -9,3 +9,3 @@ import * as coreHttp from "@azure/core-http"; | ||
* Initialize a new instance of the class Chat class. | ||
* @param client Reference to the service client | ||
* @param client - Reference to the service client | ||
*/ | ||
@@ -15,4 +15,4 @@ constructor(client: ChatApiClient); | ||
* Creates a chat thread. | ||
* @param createChatThreadRequest Request payload for creating a chat thread. | ||
* @param options The options parameters. | ||
* @param createChatThreadRequest - Request payload for creating a chat thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -22,3 +22,3 @@ createChatThread(createChatThreadRequest: CreateChatThreadRequest, options?: ChatCreateChatThreadOptionalParams): Promise<ChatCreateChatThreadResponse>; | ||
* Gets the list of chat threads of a user. | ||
* @param options The options parameters. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -28,4 +28,4 @@ listChatThreads(options?: ChatListChatThreadsOptionalParams): Promise<ChatListChatThreadsResponse>; | ||
* Gets a chat thread. | ||
* @param chatThreadId Id of the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -35,4 +35,4 @@ getChatThread(chatThreadId: string, options?: coreHttp.OperationOptions): Promise<ChatGetChatThreadResponse>; | ||
* Deletes a thread. | ||
* @param chatThreadId Id of the thread to be deleted. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread to be deleted. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -42,4 +42,4 @@ deleteChatThread(chatThreadId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>; | ||
* ListChatThreadsNext | ||
* @param nextLink The nextLink from the previous successful call to the ListChatThreads method. | ||
* @param options The options parameters. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatThreads method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -46,0 +46,0 @@ listChatThreadsNext(nextLink: string, options?: ChatListChatThreadsNextOptionalParams): Promise<ChatListChatThreadsNextResponse>; |
@@ -9,3 +9,3 @@ import * as coreHttp from "@azure/core-http"; | ||
* Initialize a new instance of the class ChatThread class. | ||
* @param client Reference to the service client | ||
* @param client - Reference to the service client | ||
*/ | ||
@@ -15,4 +15,4 @@ constructor(client: ChatApiClient); | ||
* Gets chat message read receipts for a thread. | ||
* @param chatThreadId Thread id to get the chat message read receipts for. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get the chat message read receipts for. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -22,5 +22,5 @@ listChatReadReceipts(chatThreadId: string, options?: ChatThreadListChatReadReceiptsOptionalParams): Promise<ChatThreadListChatReadReceiptsResponse>; | ||
* Sends a read receipt event to a thread, on behalf of a user. | ||
* @param chatThreadId Thread id to send the read receipt event to. | ||
* @param sendReadReceiptRequest Read receipt details. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to send the read receipt event to. | ||
* @param sendReadReceiptRequest - Read receipt details. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -30,5 +30,5 @@ sendChatReadReceipt(chatThreadId: string, sendReadReceiptRequest: SendReadReceiptRequest, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>; | ||
* Sends a message to a thread. | ||
* @param chatThreadId The thread id to send the message to. | ||
* @param sendChatMessageRequest Details of the message to send. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to send the message to. | ||
* @param sendChatMessageRequest - Details of the message to send. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -38,4 +38,4 @@ sendChatMessage(chatThreadId: string, sendChatMessageRequest: SendChatMessageRequest, options?: coreHttp.OperationOptions): Promise<ChatThreadSendChatMessageResponse>; | ||
* Gets a list of messages from a thread. | ||
* @param chatThreadId The thread id of the message. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id of the message. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -45,5 +45,5 @@ listChatMessages(chatThreadId: string, options?: ChatThreadListChatMessagesOptionalParams): Promise<ChatThreadListChatMessagesResponse>; | ||
* Gets a message by id. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -53,6 +53,6 @@ getChatMessage(chatThreadId: string, chatMessageId: string, options?: coreHttp.OperationOptions): Promise<ChatThreadGetChatMessageResponse>; | ||
* Updates a message. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param updateChatMessageRequest Details of the request to update the message. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param updateChatMessageRequest - Details of the request to update the message. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -62,5 +62,5 @@ updateChatMessage(chatThreadId: string, chatMessageId: string, updateChatMessageRequest: UpdateChatMessageRequest, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>; | ||
* Deletes a message. | ||
* @param chatThreadId The thread id to which the message was sent. | ||
* @param chatMessageId The message id. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id to which the message was sent. | ||
* @param chatMessageId - The message id. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -70,4 +70,4 @@ deleteChatMessage(chatThreadId: string, chatMessageId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>; | ||
* Posts a typing event to a thread, on behalf of a user. | ||
* @param chatThreadId Id of the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -77,4 +77,4 @@ sendTypingNotification(chatThreadId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>; | ||
* Gets the participants of a thread. | ||
* @param chatThreadId Thread id to get participants for. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get participants for. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -84,5 +84,5 @@ listChatParticipants(chatThreadId: string, options?: ChatThreadListChatParticipantsOptionalParams): Promise<ChatThreadListChatParticipantsResponse>; | ||
* Remove a participant from a thread. | ||
* @param chatThreadId Thread id to remove the participant from. | ||
* @param chatParticipantId Id of the thread participant to remove from the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to remove the participant from. | ||
* @param chatParticipantId - Id of the thread participant to remove from the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -92,5 +92,5 @@ removeChatParticipant(chatThreadId: string, chatParticipantId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>; | ||
* Adds thread participants to a thread. If participants already exist, no change occurs. | ||
* @param chatThreadId Id of the thread to add participants to. | ||
* @param addChatParticipantsRequest Thread participants to be added to the thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Id of the thread to add participants to. | ||
* @param addChatParticipantsRequest - Thread participants to be added to the thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -100,5 +100,5 @@ addChatParticipants(chatThreadId: string, addChatParticipantsRequest: AddChatParticipantsRequest, options?: coreHttp.OperationOptions): Promise<ChatThreadAddChatParticipantsResponse>; | ||
* Updates a thread's properties. | ||
* @param chatThreadId The id of the thread to update. | ||
* @param updateChatThreadRequest Request payload for updating a chat thread. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The id of the thread to update. | ||
* @param updateChatThreadRequest - Request payload for updating a chat thread. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -108,5 +108,5 @@ updateChatThread(chatThreadId: string, updateChatThreadRequest: UpdateChatThreadRequest, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>; | ||
* ListChatReadReceiptsNext | ||
* @param chatThreadId Thread id to get the chat message read receipts for. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatReadReceipts method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get the chat message read receipts for. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatReadReceipts method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -116,5 +116,5 @@ listChatReadReceiptsNext(chatThreadId: string, nextLink: string, options?: ChatThreadListChatReadReceiptsNextOptionalParams): Promise<ChatThreadListChatReadReceiptsNextResponse>; | ||
* ListChatMessagesNext | ||
* @param chatThreadId The thread id of the message. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatMessages method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - The thread id of the message. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatMessages method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -124,5 +124,5 @@ listChatMessagesNext(chatThreadId: string, nextLink: string, options?: ChatThreadListChatMessagesNextOptionalParams): Promise<ChatThreadListChatMessagesNextResponse>; | ||
* ListChatParticipantsNext | ||
* @param chatThreadId Thread id to get participants for. | ||
* @param nextLink The nextLink from the previous successful call to the ListChatParticipants method. | ||
* @param options The options parameters. | ||
* @param chatThreadId - Thread id to get participants for. | ||
* @param nextLink - The nextLink from the previous successful call to the ListChatParticipants method. | ||
* @param options - The options parameters. | ||
*/ | ||
@@ -129,0 +129,0 @@ listChatParticipantsNext(chatThreadId: string, nextLink: string, options?: ChatThreadListChatParticipantsNextOptionalParams): Promise<ChatThreadListChatParticipantsNextResponse>; |
@@ -7,3 +7,3 @@ import { ChatParticipant } from "./models"; | ||
*/ | ||
export interface SendMessageRequest extends Omit<RestSendMessageRequest, "priority" | "senderDisplayName"> { | ||
export interface SendMessageRequest extends Omit<RestSendMessageRequest, "type" | "senderDisplayName"> { | ||
} | ||
@@ -10,0 +10,0 @@ /** |
@@ -6,4 +6,4 @@ import { Span } from "@opentelemetry/api"; | ||
* @ignore | ||
* @param name The name of the operation being performed. | ||
* @param tracingOptions The options for the underlying http request. | ||
* @param name - The name of the operation being performed. | ||
* @param tracingOptions - The options for the underlying http request. | ||
*/ | ||
@@ -10,0 +10,0 @@ export declare function createSpan<T extends OperationOptions>(operationName: string, operationOptions: T): { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
778654
11278