ChatThreadClient class

Paket:

@azure/communication-chat

Sohbet işlemlerini yapmak için istemci

Oluşturucular

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Özellikler

threadId

ChatThreadClient İş Parçacığı Kimliği

Yöntemler

addParticipants(AddParticipantsRequest, OperationOptions)	ThreadId tarafından tanımlanan yazışmaya ait sohbet katılımcılarının ayrıntılarını ekler.
deleteMessage(string, OperationOptions)	threadId ve messageId ile tanımlanan bir iletiyi siler
getMessage(string, OperationOptions)	messageId ile tanımlanan bir sohbet iletisi alır. Belirli bir iletiyi döndürür.
getProperties(OperationOptions)	Sohbet yazışması alır. Sohbet yazışmasını döndürür.
listMessages(ChatThreadListChatMessagesOptionalParams)	threadId tarafından tanımlanan bir iş parçacığından ileti listesini alır. İletilerin listesini döndürür.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	ThreadId tarafından tanımlanan iş parçacığının katılımcılarını alır. Katılımcıların listelerini döndürür.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	threadId tarafından tanımlanan bir iş parçacığından okundu bilgisinin listesini alır. İletilerin listesini döndürür.
removeParticipant(CommunicationIdentifier, OperationOptions)	ThreadId tarafından tanımlanan iş parçacığından katılımcıyı kaldırır.
sendMessage(SendMessageRequest, SendMessageOptions)	ThreadId tarafından tanımlanan bir yazışmaya sohbet iletisi gönderir. Oluşturulan iletinin kimliğini döndürür.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	ThreadId tarafından tanımlanan iş parçacığına bir okundu bilgisi gönderir.
sendTypingNotification(SendTypingNotificationOptions)	yazışmaya bir yazma bildirimi gönderir. Son bildirimden bu yana geçen süre en düşük yazma aralığından küçükse göndermeye çalışmaz
updateMessage(string, UpdateMessageOptions)	threadId ve messageId ile tanımlanan bir iletiyi güncelleştirir
updateProperties(UpdateChatThreadPropertiesOptions)	bir iş parçacığının özelliklerini güncelleştirir.
updateTopic(string, UpdateTopicOptions)	bir iş parçacığının konusunu güncelleştirir.

Oluşturucu Ayrıntıları

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions)

Parametreler

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Özellik Ayrıntıları

threadId

ChatThreadClient İş Parçacığı Kimliği

threadId: string

Özellik Değeri

string

Yöntem Ayrıntıları

addParticipants(AddParticipantsRequest, OperationOptions)

ThreadId tarafından tanımlanan yazışmaya ait sohbet katılımcılarının ayrıntılarını ekler.

function addParticipants(request: AddParticipantsRequest, options?: OperationOptions): Promise<AddChatParticipantsResult>

Parametreler

request

AddParticipantsRequest

İş parçacığı listesine eklenecek iş parçacığı katılımcılarının ayrıntıları

options

OperationOptions

İşlem seçenekleri.

Döndürülenler

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

threadId ve messageId ile tanımlanan bir iletiyi siler

function deleteMessage(messageId: string, options?: OperationOptions): Promise<void>

Parametreler

messageId

string

İletinin ileti kimliği.

options

OperationOptions

İşlem seçenekleri.

Döndürülenler

Promise<void>

getMessage(string, OperationOptions)

messageId ile tanımlanan bir sohbet iletisi alır. Belirli bir iletiyi döndürür.

function getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>

Parametreler

messageId

string

İletinin ileti kimliği.

options

OperationOptions

İşlem seçenekleri.

Döndürülenler

Promise<ChatMessage>

getProperties(OperationOptions)

Sohbet yazışması alır. Sohbet yazışmasını döndürür.

function getProperties(options?: OperationOptions): Promise<ChatThreadProperties>

Parametreler

options

OperationOptions

İşlem seçenekleri.

Döndürülenler

Promise<ChatThreadProperties>

listMessages(ChatThreadListChatMessagesOptionalParams)

threadId tarafından tanımlanan bir iş parçacığından ileti listesini alır. İletilerin listesini döndürür.

function listMessages(options?: ChatThreadListChatMessagesOptionalParams): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

Parametreler

options

RestListMessagesOptions

İleti seçeneklerini alma.

Döndürülenler

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

ThreadId tarafından tanımlanan iş parçacığının katılımcılarını alır. Katılımcıların listelerini döndürür.

function listParticipants(options?: ChatThreadListChatParticipantsOptionalParams): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

Parametreler

options

RestListParticipantsOptions

İşlem seçenekleri.

Döndürülenler

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

threadId tarafından tanımlanan bir iş parçacığından okundu bilgisinin listesini alır. İletilerin listesini döndürür.

function listReadReceipts(options?: ChatThreadListChatReadReceiptsOptionalParams): PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

Parametreler

options

RestListReadReceiptsOptions

İleti seçeneklerini alma.

Döndürülenler

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

ThreadId tarafından tanımlanan iş parçacığından katılımcıyı kaldırır.

function removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>

Parametreler

participant

CommunicationIdentifier

İş parçacığı listesinden kaldırılacak iş parçacığı katılımcısı

options

OperationOptions

İşlem seçenekleri.

Döndürülenler

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

ThreadId tarafından tanımlanan bir yazışmaya sohbet iletisi gönderir. Oluşturulan iletinin kimliğini döndürür.

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

Parametreler

request

SendMessageRequest

İleti gönderme isteği.

options

SendMessageOptions

İşlem seçenekleri.

Döndürülenler

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

ThreadId tarafından tanımlanan iş parçacığına bir okundu bilgisi gönderir.

function sendReadReceipt(request: SendReadReceiptRequest, options?: OperationOptions): Promise<void>

Parametreler

request

SendReadReceiptRequest

Okundu bilgisi gönderme isteği

options

OperationOptions

İşlem seçenekleri.

Döndürülenler

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

yazışmaya bir yazma bildirimi gönderir. Son bildirimden bu yana geçen süre en düşük yazma aralığından küçükse göndermeye çalışmaz

function sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>

Parametreler

options

SendTypingNotificationOptions

İşlem seçenekleri

Döndürülenler

Promise<boolean>

Yazma iletisi bildirimi gönderilebiliyorsa true, aksi takdirde false.

updateMessage(string, UpdateMessageOptions)

threadId ve messageId ile tanımlanan bir iletiyi güncelleştirir

function updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<void>

Parametreler

messageId

string

İletinin ileti kimliği.

options

UpdateMessageOptions

İşlem seçenekleri.

Döndürülenler

Promise<void>

updateProperties(UpdateChatThreadPropertiesOptions)

bir iş parçacığının özelliklerini güncelleştirir.

function updateProperties(options?: UpdateChatThreadPropertiesOptions): Promise<void>

Parametreler

options

UpdateChatThreadPropertiesOptions

İşlem seçenekleri.

Döndürülenler

Promise<void>

updateTopic(string, UpdateTopicOptions)

bir iş parçacığının konusunu güncelleştirir.

function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>

Parametreler

topic

string

Konunun güncelleştirilmesi gerekir.

options

UpdateTopicOptions

İşlem seçenekleri.

Döndürülenler

Promise<void>