ChatThread | @azure/communication-chat

Class representing a ChatThread. Chat thread.

Hierarchy

ChatThread

Index

Constructors

constructor

Properties

Methods

Object literals

type

Constructors

constructor

new ChatThread(client: ChatApiClient): ChatThread

- Defined in generated/src/operations/chatThread.ts:39
Initialize a new instance of the class ChatThread class.

Parameters
- client: ChatApiClient
  
  Reference to the service client
Returns ChatThread

Properties

Optional createdBy

createdBy: CommunicationIdentifierKind

Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set.

createdOn

createdOn: Date

The timestamp when the chat thread was created. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

Optional deletedOn

deletedOn: Date

The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

id

id: string

Chat thread id.

topic

topic: string

Chat thread topic.

Methods

addChatParticipants

addChatParticipants(chatThreadId: string, addChatParticipantsRequest: AddChatParticipantsRequest, options?: coreHttp.OperationOptions): Promise<ChatThreadAddChatParticipantsResponse>

- Defined in generated/src/operations/chatThread.ts:266
Adds thread participants to a thread. If participants already exist, no change occurs.

Parameters
- chatThreadId: string
  
  Id of the thread to add participants to.
- addChatParticipantsRequest: AddChatParticipantsRequest
  
  Thread participants to be added to the thread.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<ChatThreadAddChatParticipantsResponse>

deleteChatMessage

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

- Defined in generated/src/operations/chatThread.ts:184
Deletes a message.

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

getChatMessage

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

- Defined in generated/src/operations/chatThread.ts:137
Gets a message by id.

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

listChatMessages

listChatMessages(chatThreadId: string, options?: ChatThreadListChatMessagesOptionalParams): Promise<ChatThreadListChatMessagesResponse>

- Defined in generated/src/operations/chatThread.ts:117
Gets a list of messages from a thread.

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

listChatMessagesNext

listChatMessagesNext(chatThreadId: string, nextLink: string, options?: ChatThreadListChatMessagesNextOptionalParams): Promise<ChatThreadListChatMessagesNextResponse>

- Defined in generated/src/operations/chatThread.ts:332
ListChatMessagesNext

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

listChatParticipants

listChatParticipants(chatThreadId: string, options?: ChatThreadListChatParticipantsOptionalParams): Promise<ChatThreadListChatParticipantsResponse>

- Defined in generated/src/operations/chatThread.ts:224
Gets the participants of a thread.

Parameters
- chatThreadId: string
  
  Thread id to get participants for.
- Optional options: ChatThreadListChatParticipantsOptionalParams
  
  The options parameters.
Returns Promise<ChatThreadListChatParticipantsResponse>

listChatParticipantsNext

listChatParticipantsNext(chatThreadId: string, nextLink: string, options?: ChatThreadListChatParticipantsNextOptionalParams): Promise<ChatThreadListChatParticipantsNextResponse>

- Defined in generated/src/operations/chatThread.ts:354
ListChatParticipantsNext

Parameters
- chatThreadId: string
  
  Thread id to get participants for.
- nextLink: string
  
  The nextLink from the previous successful call to the ListChatParticipants method.
- Optional options: ChatThreadListChatParticipantsNextOptionalParams
  
  The options parameters.
Returns Promise<ChatThreadListChatParticipantsNextResponse>

listChatReadReceipts

listChatReadReceipts(chatThreadId: string, options?: ChatThreadListChatReadReceiptsOptionalParams): Promise<ChatThreadListChatReadReceiptsResponse>

- Defined in generated/src/operations/chatThread.ts:54
Gets chat message read receipts for a thread.

Parameters
- chatThreadId: string
  
  Thread id to get the chat message read receipts for.
- Optional options: ChatThreadListChatReadReceiptsOptionalParams
  
  The options parameters.
Returns Promise<ChatThreadListChatReadReceiptsResponse>

listChatReadReceiptsNext

listChatReadReceiptsNext(chatThreadId: string, nextLink: string, options?: ChatThreadListChatReadReceiptsNextOptionalParams): Promise<ChatThreadListChatReadReceiptsNextResponse>

- Defined in generated/src/operations/chatThread.ts:310
ListChatReadReceiptsNext

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

removeChatParticipant

removeChatParticipant(chatThreadId: string, participantCommunicationIdentifier: CommunicationIdentifierModel, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in generated/src/operations/chatThread.ts:244
Remove a participant from a thread.

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

sendChatMessage

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

- Defined in generated/src/operations/chatThread.ts:96
Sends a message to a thread.

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

sendChatReadReceipt

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

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

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

sendTypingNotification

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

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

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

updateChatMessage

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

- Defined in generated/src/operations/chatThread.ts:160
Updates a message.

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

updateChatThread

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

- Defined in generated/src/operations/chatThread.ts:288
Updates a thread's properties.

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

Object literals

type

type: object

className

className: string = "ChatThread"

name

modelProperties

modelProperties: object

createdByCommunicationIdentifier

createdByCommunicationIdentifier: object

serializedName

serializedName: string = "createdByCommunicationIdentifier"

type

type: object

className

className: string = "CommunicationIdentifierModel"

name

createdOn

createdOn: object

required

required: boolean = true

serializedName

serializedName: string = "createdOn"

type

type: object

name

deletedOn

deletedOn: object

serializedName

serializedName: string = "deletedOn"

type

type: object

name

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

topic

topic: object

required

required: boolean = true

serializedName

serializedName: string = "topic"

type

type: object

name

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

client: ChatApiClient

Returns ChatThread

Properties

Optional createdBy

createdOn

Optional deletedOn

id

topic

Methods

addChatParticipants

Parameters

chatThreadId: string

addChatParticipantsRequest: AddChatParticipantsRequest

Optional options: coreHttp.OperationOptions

Returns Promise<ChatThreadAddChatParticipantsResponse>

deleteChatMessage

Parameters

chatThreadId: string

chatMessageId: string

Optional options: coreHttp.OperationOptions

Returns Promise<coreHttp.RestResponse>

getChatMessage

Parameters

chatThreadId: string

chatMessageId: string

Optional options: coreHttp.OperationOptions

Returns Promise<ChatThreadGetChatMessageResponse>

listChatMessages

Parameters

chatThreadId: string

Optional options: ChatThreadListChatMessagesOptionalParams

Returns Promise<ChatThreadListChatMessagesResponse>

listChatMessagesNext

Parameters

chatThreadId: string

nextLink: string

Optional options: ChatThreadListChatMessagesNextOptionalParams

Returns Promise<ChatThreadListChatMessagesNextResponse>

listChatParticipants

Parameters

chatThreadId: string

Optional options: ChatThreadListChatParticipantsOptionalParams

Returns Promise<ChatThreadListChatParticipantsResponse>

listChatParticipantsNext

Parameters

chatThreadId: string

nextLink: string

Optional options: ChatThreadListChatParticipantsNextOptionalParams

Returns Promise<ChatThreadListChatParticipantsNextResponse>

listChatReadReceipts

Parameters

chatThreadId: string

Optional options: ChatThreadListChatReadReceiptsOptionalParams

Returns Promise<ChatThreadListChatReadReceiptsResponse>

listChatReadReceiptsNext

Parameters

chatThreadId: string

nextLink: string

Optional options: ChatThreadListChatReadReceiptsNextOptionalParams

Returns Promise<ChatThreadListChatReadReceiptsNextResponse>

removeChatParticipant

Parameters

chatThreadId: string

participantCommunicationIdentifier: CommunicationIdentifierModel

Optional options: coreHttp.OperationOptions

Returns Promise<coreHttp.RestResponse>

sendChatMessage

Parameters

chatThreadId: string

sendChatMessageRequest: SendChatMessageRequest

Optional options: coreHttp.OperationOptions