@azure/communication-chat package
Classes
| ChatClient |
The client to do chat operations |
| ChatThreadClient |
The client to do chat operations |
Interfaces
| AddChatParticipantsResult |
Result of the add chat participants operation. |
| AddParticipantsRequest |
Participants to be added to the thread. |
| ChatAttachment |
An attachment in a chat message. |
| ChatClientOptions |
Options to create chat client. |
| ChatError |
The Communication Services error. |
| ChatMessage |
Chat message. |
| ChatMessageContent |
Content of a chat message. |
| ChatMessageDeletedEvent |
Event for a deleted chat message. All chat participants receive this event, including the original sender |
| ChatMessageEditedEvent |
Event for a edited chat message. All chat participants receive this event, including the original sender |
| ChatMessageReadReceipt |
A chat message read receipt indicates the time a chat message was read by a recipient. |
| ChatMessageReceivedEvent |
Event for a received chat message. All chat participants receive this event, including the original sender |
| ChatParticipant |
A participant of the chat thread. |
| ChatThreadClientOptions |
Options to create chat thread client. |
| ChatThreadCreatedEvent |
Event for a created chat thread. All chat participants receive this event, including the original sender |
| ChatThreadDeletedEvent |
Event for an updated chat thread. All chat participants receive this event, including the original sender |
| ChatThreadItem |
Summary information of a chat thread. |
| ChatThreadProperties |
Chat thread. |
| ChatThreadPropertiesUpdatedEvent |
Event for an updated chat thread. All chat participants receive this event, including the original sender |
| CreateChatThreadOptions |
Options to create a chat thread. |
| CreateChatThreadRequest |
Request payload for creating a chat thread. |
| CreateChatThreadResult |
Result of the create chat thread operation. |
| ListPageSettings |
Arguments for retrieving the next page of search results. |
| MessagingPolicy |
Messaging policy of a chat thread. |
| NoneRetentionPolicy |
No thread retention policy. |
| ParticipantsAddedEvent |
Event for participants added to a chat thread. All chat participants receive this event, including the original sender |
| ParticipantsRemovedEvent |
Event for a participant added to a chat thread. All chat participants receive this event, including the original sender |
| PolicyViolation |
Policy violation of a message (if applicable). |
| ReadReceiptReceivedEvent |
Event for a received read receipt |
| RestListChatThreadsOptions |
Optional parameters. |
| RestListMessagesOptions |
Optional parameters. |
| RestListParticipantsOptions |
Optional parameters. |
| RestListReadReceiptsOptions |
Optional parameters. |
| SendChatMessageResult |
Result of the send message operation. |
| SendMessageOptions |
Options to send a chat message. |
| SendMessageRequest |
Details of the message to send. |
| SendReadReceiptRequest |
Request payload for sending a read receipt. |
| SendTypingNotificationOptions |
Options to send typing notifications. |
| StreamingChatMessageChunkReceivedEvent |
Event for a received streaming chat message chunk. |
| StreamingChatMessageStartEvent |
Event for a received streaming chat message start event. |
| StreamingMessageMetadata |
Type definition for information on a streaming message |
| ThreadCreationDateRetentionPolicy |
Thread retention policy based on thread creation date. |
| TypingIndicatorReceivedEvent |
Event for a received typing indicator when a chat participant is typing. All chat participants receive this event, including the original sender |
| UpdateChatThreadPropertiesOptions |
Options to update a chat thread. |
| UpdateMessageOptions |
Options to update a chat message. |
| UpdateTopicOptions |
Options to update a chat thread. |
| UploadChatImageResult |
Result payload for uploading an image. |
| UploadImageOptions |
Options to upload a chat image. |
Type Aliases
| AddParticipantsOptions |
Options to add a chat participant. |
| ChatAttachmentType |
Type of Supported Attachments. |
| ChatEventId | |
| ChatMessageType |
Defines values for ChatMessageType. |
| ChatRetentionPolicy |
Data retention policy for auto deletion. |
| DeleteChatThreadOptions |
Options to delete a chat thread. |
| DeleteImageOptions |
Options to delete a chat image. |
| DeleteMessageOptions |
Options to delete a chat message. |
| GetMessageOptions |
Options to get a chat message. |
| GetPropertiesOptions |
Options to get a chat thread. |
| ListChatThreadsOptions |
Options to get chat threads. |
| ListMessagesOptions |
Options to list chat messages. |
| ListParticipantsOptions |
Options to list chat participants. |
| ListReadReceiptsOptions |
Options to list read receipts. |
| PolicyViolationMessageResult |
Result of Policy Violation message. |
| RemoveParticipantOptions |
Options to remove a chat participant. |
| SendReadReceiptOptions |
Options to send read receipt. |
| StreamEndReason |
Reason for the end of a streaming message |
| StreamingMessageType |
Type of a streaming message |
| UploadImageStreamOptions |
Options to upload a chat image stream. |
