ChatThreadClient class

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

المعلمات

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

threadId: string

قيمة الخاصية

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

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

المعلمات

المرتجعات

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

function deleteImage(imageId: string, options?: OperationOptions): Promise<void>

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

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

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

المعلمات

المرتجعات

تحميل صورة دردشة إلى سلسلة محادثات تم تحديدها بواسطة threadId. أنواع الصور المسموح بها "jpg" ، "png" ، "gif" ، "heic" ، "webp". إرجاع معرف الصورة التي تم تحميلها.

function uploadImage(image: ArrayBuffer | Blob, imageFilename: string, options?: UploadImageOptions): Promise<UploadChatImageResult>

المعلمات

المرتجعات

تحميل دفق صور دردشة إلى سلسلة رسائل تم تحديدها بواسطة threadId. أنواع الصور المسموح بها "jpg" ، "png" ، "gif" ، "heic" ، "webp". إرجاع معرف الصورة التي تم تحميلها.

function uploadImage(image: ReadableStream<Uint8Array> | ReadableStream, imageFileName: string, imageBytesLength: number, options?: OperationOptions): Promise<UploadChatImageResult>

المعلمات

المرتجعات