ChatThreadClient class

الحزمة:

@azure/communication-chat

العميل للقيام بعمليات الدردشة

المنشئون

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

الخصائص

threadId

معرف مؤشر الترابط ل ChatThreadClient

الأساليب

addParticipants(AddParticipantsRequest, OperationOptions)	يضيف تفاصيل المشاركين في الدردشة الذين ينتمون إلى مؤشر الترابط المحدد بواسطة threadId.
deleteMessage(string, OperationOptions)	حذف رسالة تم تحديدها بواسطة threadId و messageId
getMessage(string, OperationOptions)	يحصل على رسالة دردشة تم تعريفها بواسطة messageId. إرجاع الرسالة المحددة.
getProperties(OperationOptions)	الحصول على مؤشر ترابط دردشة. إرجاع مؤشر ترابط الدردشة.
listMessages(ChatThreadListChatMessagesOptionalParams)	يحصل على قائمة رسائل من مؤشر ترابط تم تحديده بواسطة threadId. إرجاع قائمة الرسائل.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	يحصل على المشاركين في مؤشر الترابط المحدد بواسطة threadId. إرجاع قوائم المشاركين.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	يحصل على قائمة بإيصال القراءة من مؤشر ترابط تم تحديده بواسطة threadId. إرجاع قائمة الرسائل.
removeParticipant(CommunicationIdentifier, OperationOptions)	يزيل المشارك من مؤشر الترابط الذي تم تحديده بواسطة threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	إرسال رسالة دردشة إلى مؤشر ترابط تم تحديده بواسطة threadId. إرجاع معرف الرسالة التي تم إنشاؤها.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	يرسل إيصال قراءة إلى مؤشر الترابط المحدد بواسطة threadId.
sendTypingNotification(SendTypingNotificationOptions)	إرسال إعلام كتابة إلى مؤشر الترابط. لا يحاول الإرسال إذا كان الوقت منذ آخر إعلام أصغر من الحد الأدنى للفاصل الزمني للكتابة
updateMessage(string, UpdateMessageOptions)	تحديث رسالة تم تحديدها بواسطة threadId و messageId
updateProperties(UpdateChatThreadPropertiesOptions)	تحديث خصائص سلسلة المحادثات.
updateTopic(string, UpdateTopicOptions)	تحديث موضوع مؤشر ترابط.

تفاصيل المنشئ

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

المعلمات

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

تفاصيل الخاصية

threadId

معرف مؤشر الترابط ل ChatThreadClient

threadId: string

قيمة الخاصية

string

تفاصيل الأسلوب

addParticipants(AddParticipantsRequest, OperationOptions)

يضيف تفاصيل المشاركين في الدردشة الذين ينتمون إلى مؤشر الترابط المحدد بواسطة threadId.

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

المعلمات

request

AddParticipantsRequest

تفاصيل المشاركين في مؤشر الترابط لإضافتها في قائمة مؤشرات الترابط

options

OperationOptions

خيارات العملية.

المرتجعات

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

حذف رسالة تم تحديدها بواسطة threadId و messageId

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

المعلمات

messageId

string

معرف الرسالة للرسالة.

options

OperationOptions

خيارات العملية.

المرتجعات

Promise<void>

getMessage(string, OperationOptions)

يحصل على رسالة دردشة تم تعريفها بواسطة messageId. إرجاع الرسالة المحددة.

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

المعلمات

messageId

string

معرف الرسالة للرسالة.

options

OperationOptions

خيارات العملية.

المرتجعات

Promise<ChatMessage>

getProperties(OperationOptions)

الحصول على مؤشر ترابط دردشة. إرجاع مؤشر ترابط الدردشة.

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

المعلمات

options

OperationOptions

خيارات العملية.

المرتجعات

Promise<ChatThreadProperties>

listMessages(ChatThreadListChatMessagesOptionalParams)

يحصل على قائمة رسائل من مؤشر ترابط تم تحديده بواسطة threadId. إرجاع قائمة الرسائل.

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

المعلمات

options

RestListMessagesOptions

الحصول على خيارات الرسائل.

المرتجعات

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

يحصل على المشاركين في مؤشر الترابط المحدد بواسطة threadId. إرجاع قوائم المشاركين.

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

المعلمات

options

RestListParticipantsOptions

خيارات العملية.

المرتجعات

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

يحصل على قائمة بإيصال القراءة من مؤشر ترابط تم تحديده بواسطة threadId. إرجاع قائمة الرسائل.

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

المعلمات

options

RestListReadReceiptsOptions

الحصول على خيارات الرسائل.

المرتجعات

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

يزيل المشارك من مؤشر الترابط الذي تم تحديده بواسطة threadId.

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

المعلمات

participant

CommunicationIdentifier

مشارك مؤشر ترابط لإزالته من قائمة مؤشرات الترابط

options

OperationOptions

خيارات العملية.

المرتجعات

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

إرسال رسالة دردشة إلى مؤشر ترابط تم تحديده بواسطة threadId. إرجاع معرف الرسالة التي تم إنشاؤها.

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

المعلمات

request

SendMessageRequest

طلب إرسال رسالة.

options

SendMessageOptions

خيارات العملية.

المرتجعات

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

يرسل إيصال قراءة إلى مؤشر الترابط المحدد بواسطة threadId.

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

المعلمات

request

SendReadReceiptRequest

طلب إرسال إيصال بالقراءة

options

OperationOptions

خيارات العملية.

المرتجعات

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

إرسال إعلام كتابة إلى مؤشر الترابط. لا يحاول الإرسال إذا كان الوقت منذ آخر إعلام أصغر من الحد الأدنى للفاصل الزمني للكتابة

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

المعلمات

options

SendTypingNotificationOptions

خيارات العملية

المرتجعات

Promise<boolean>

صحيح إذا كان من الممكن إرسال إعلام رسالة الكتابة، وإلا فسيكون خطأ.

updateMessage(string, UpdateMessageOptions)

تحديث رسالة تم تحديدها بواسطة threadId و messageId

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

المعلمات

messageId

string

معرف الرسالة للرسالة.

options

UpdateMessageOptions

خيارات العملية.

المرتجعات

Promise<void>

updateProperties(UpdateChatThreadPropertiesOptions)

تحديث خصائص سلسلة المحادثات.

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

المعلمات

options

UpdateChatThreadPropertiesOptions

خيارات العملية.

المرتجعات

Promise<void>

updateTopic(string, UpdateTopicOptions)

تحديث موضوع مؤشر ترابط.

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

المعلمات

topic

string

يجب تحديث الموضوع إلى.

options

UpdateTopicOptions

خيارات العملية.

المرتجعات

Promise<void>