StatefulChatClient interface

الحزمة:

@azure/communication-react

يحدد الأساليب التي تسمح باستخدام {@Link @azure/communication-chat#ChatClient} مع حالة مركزية تم إنشاؤها.

توفر الواجهة الوصول إلى الحالة المنقلة وتسمح أيضا بتسجيل معالج لأحداث تغيير الحالة.

يمتد

ChatClient

الأساليب

dispose()	ينظف ذاكرة التخزين المؤقت للمورد من عميل مؤشر ترابط الدردشة.
downloadResourceToCache(string, string, string)	تنزيل مورد لرسالة معينة وتخزينه مؤقتا.
getState()	يحتفظ بجميع الحالة التي يمكننا أن نوكيلها من ChatClient {@Link @azure/communication-chat#ChatClient} ك ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	يسمح بإلغاء التسجيل لأحداث "stateChanged".
onStateChange((state: ChatClientState) => void)	يسمح بتسجيل معالج لأحداث "stateChanged".
removeResourceFromCache(string, string, string)	إزالة مورد من ذاكرة التخزين المؤقت لرسالة معينة.

الأساليب المتوارثة

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	إنشاء مؤشر ترابط دردشة. إرجاع عميل مؤشر الترابط بمعرف مؤشر الترابط الذي تم إنشاؤه.
deleteChatThread(string, OperationOptions)	حذف مؤشر ترابط دردشة.
getChatThreadClient(string)	إرجاع ChatThreadClient مع معرف مؤشر الترابط المحدد.
listChatThreads(ChatListChatThreadsOptionalParams)	الحصول على قائمة مؤشرات ترابط الدردشة للمستخدم.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	إلغاء الاشتراك من chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	إلغاء الاشتراك من chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	إلغاء الاشتراك من chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	إلغاء الاشتراك من chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	إلغاء الاشتراك من الدردشةThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	إلغاء الاشتراك من chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	إلغاء الاشتراك من المشاركين المضافين.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	إلغاء الاشتراك من المشاركينRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	إلغاء الاشتراك من readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	إلغاء الاشتراك من typingIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	قم بالاشتراك في دالة chatMessageDeleted. سيتلقى المرسل الأولي هذا الحدث أيضا.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	قم بالاشتراك في وظيفة chatMessageEdited. سيتلقى المرسل الأولي هذا الحدث أيضا.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	قم بالاشتراك في دالة chatMessageReceived. سيتلقى المرسل الأولي هذا الحدث أيضا. تحتاج إلى استدعاء startRealtimeNotifications قبل الاشتراك في أي حدث.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	قم بالاشتراك في دالة الدردشةThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	قم بالاشتراك في دالة الدردشةThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	وظيفة الاشتراك للدردشةThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	تمت إضافة وظيفة الاشتراك للمشاركين.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	وظيفة الاشتراك للمشاركينRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	قم بالاشتراك في دالة readReceiptReceived.
on("realTimeNotificationConnected", () => void)	قم بالاشتراك في دالة realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	قم بالاشتراك في دالة realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	قم بالاشتراك في دالة ل typingIndicatorReceived. سيتلقى المرسل الأولي هذا الحدث أيضا.
startRealtimeNotifications()	ابدأ في تلقي الإعلامات في الوقت الحقيقي. قم باستدعاء هذه الدالة قبل الاشتراك في أي حدث.
stopRealtimeNotifications()	إيقاف تلقي الإعلامات في الوقت الحقيقي. ستقوم هذه الدالة بإلغاء الاشتراك في جميع الأحداث.

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

dispose()

ينظف ذاكرة التخزين المؤقت للمورد من عميل مؤشر ترابط الدردشة.

function dispose()

downloadResourceToCache(string, string, string)

تنزيل مورد لرسالة معينة وتخزينه مؤقتا.

function downloadResourceToCache(threadId: string, messageId: string, resourceUrl: string)

المعلمات

threadId

string

معرف مؤشر الترابط لسلسلة المحادثات.

messageId

string

معرف الرسالة لرسالة المحادثة.

resourceUrl

string

عنوان URL للمورد المراد جلبه وذاكرة التخزين المؤقت.

getState()

يحتفظ بجميع الحالة التي يمكننا أن نوكيلها من ChatClient {@Link @azure/communication-chat#ChatClient} ك ChatClientState {@Link ChatClientState}.

function getState(): ChatClientState

المرتجعات

ChatClientState

offStateChange((state: ChatClientState) => void)

يسمح بإلغاء التسجيل لأحداث "stateChanged".

function offStateChange(handler: (state: ChatClientState) => void)

المعلمات

handler

(state: ChatClientState) => void

رد الاتصال الأصلي لإلغاء الاشتراك.

onStateChange((state: ChatClientState) => void)

يسمح بتسجيل معالج لأحداث "stateChanged".

function onStateChange(handler: (state: ChatClientState) => void)

المعلمات

handler

(state: ChatClientState) => void

رد الاتصال لتلقي الحالة.

removeResourceFromCache(string, string, string)

إزالة مورد من ذاكرة التخزين المؤقت لرسالة معينة.

function removeResourceFromCache(threadId: string, messageId: string, resourceUrl: string)

المعلمات

threadId

string

معرف مؤشر الترابط لسلسلة المحادثات.

messageId

string

معرف الرسالة لرسالة المحادثة.

resourceUrl

string

عنوان URL للمورد المراد إزالته من ذاكرة التخزين المؤقت.

تفاصيل الأساليب المتوارثة

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

إنشاء مؤشر ترابط دردشة. إرجاع عميل مؤشر الترابط بمعرف مؤشر الترابط الذي تم إنشاؤه.

function createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResult>

المعلمات

request

CreateChatThreadRequest

طلب إنشاء مؤشر ترابط دردشة.

options

CreateChatThreadOptions

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

المرتجعات

Promise<CreateChatThreadResult>

موروث من ChatClient.createChatThread

deleteChatThread(string, OperationOptions)

حذف مؤشر ترابط دردشة.

function deleteChatThread(threadId: string, options?: OperationOptions): Promise<void>

المعلمات

threadId

string

معرف مؤشر الترابط المراد حذفه.

options

OperationOptions

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

المرتجعات

Promise<void>

موروث من ChatClient.deleteChatThread

getChatThreadClient(string)

إرجاع ChatThreadClient مع معرف مؤشر الترابط المحدد.

function getChatThreadClient(threadId: string): ChatThreadClient

المعلمات

threadId

string

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

المرتجعات

ChatThreadClient

موروث من ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

الحصول على قائمة مؤشرات ترابط الدردشة للمستخدم.

function listChatThreads(options?: ChatListChatThreadsOptionalParams): PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

المعلمات

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

سرد خيارات مؤشرات ترابط الدردشة.

المرتجعات

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

موروث من ChatClient.listChatThreads

off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

إلغاء الاشتراك من chatMessageDeleted.

function off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

المعلمات

event

"chatMessageDeleted"

حدث ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

إلغاء الاشتراك من chatMessageEdited.

function off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

المعلمات

event

"chatMessageEdited"

حدث ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

إلغاء الاشتراك من chatMessageReceived.

function off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

المعلمات

event

"chatMessageReceived"

حدث ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

إلغاء الاشتراك من chatThreadCreated.

function off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

المعلمات

event

"chatThreadCreated"

حدث ChatThreadCreated.

listener

(e: ChatThreadCreatedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

إلغاء الاشتراك من الدردشةThreadDeleted.

function off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

المعلمات

event

"chatThreadDeleted"

حدث ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

إلغاء الاشتراك من chatThreadPropertiesUpdated.

function off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

المعلمات

event

"chatThreadPropertiesUpdated"

حدث ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("participantsAdded", (e: ParticipantsAddedEvent) => void)

إلغاء الاشتراك من المشاركين المضافين.

function off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

المعلمات

event

"participantsAdded"

تمت إضافة الحدث للمشاركين.

listener

(e: ParticipantsAddedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

إلغاء الاشتراك من المشاركينRemoved.

function off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

المعلمات

event

"participantsRemoved"

المشاركونRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

إلغاء الاشتراك من readReceiptReceived.

function off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

المعلمات

event

"readReceiptReceived"

حدث ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

إلغاء الاشتراك من typingIndicatorReceived.

function off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

المعلمات

event

"typingIndicatorReceived"

حدث TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.off

on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

قم بالاشتراك في دالة chatMessageDeleted. سيتلقى المرسل الأولي هذا الحدث أيضا.

function on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

المعلمات

event

"chatMessageDeleted"

حدث ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

قم بالاشتراك في وظيفة chatMessageEdited. سيتلقى المرسل الأولي هذا الحدث أيضا.

function on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

المعلمات

event

"chatMessageEdited"

حدث ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

قم بالاشتراك في دالة chatMessageReceived. سيتلقى المرسل الأولي هذا الحدث أيضا. تحتاج إلى استدعاء startRealtimeNotifications قبل الاشتراك في أي حدث.

function on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

المعلمات

event

"chatMessageReceived"

حدث ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

قم بالاشتراك في دالة الدردشةThreadCreated.

function on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

المعلمات

event

"chatThreadCreated"

حدث ChatThreadCreated.

listener

(e: ChatThreadCreatedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

قم بالاشتراك في دالة الدردشةThreadDeleted.

function on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

المعلمات

event

"chatThreadDeleted"

حدث ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

وظيفة الاشتراك للدردشةThreadPropertiesUpdated.

function on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

المعلمات

event

"chatThreadPropertiesUpdated"

حدث ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("participantsAdded", (e: ParticipantsAddedEvent) => void)

تمت إضافة وظيفة الاشتراك للمشاركين.

function on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

المعلمات

event

"participantsAdded"

تمت إضافة الحدث للمشاركين.

listener

(e: ParticipantsAddedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

وظيفة الاشتراك للمشاركينRemoved.

function on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

المعلمات

event

"participantsRemoved"

المشاركونRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

قم بالاشتراك في دالة readReceiptReceived.

function on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

المعلمات

event

"readReceiptReceived"

حدث ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("realTimeNotificationConnected", () => void)

قم بالاشتراك في دالة realTimeNotificationConnected.

function on(event: "realTimeNotificationConnected", listener: () => void)

المعلمات

event

"realTimeNotificationConnected"

الحدث realTimeNotificationConnected

listener

() => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("realTimeNotificationDisconnected", () => void)

قم بالاشتراك في دالة realTimeNotificationDisconnected.

function on(event: "realTimeNotificationDisconnected", listener: () => void)

المعلمات

event

"realTimeNotificationDisconnected"

حدث RealTimeNotificationDisconnected

listener

() => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

قم بالاشتراك في دالة ل typingIndicatorReceived. سيتلقى المرسل الأولي هذا الحدث أيضا.

function on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

المعلمات

event

"typingIndicatorReceived"

حدث TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

وحدة الاستماع للتعامل مع الحدث.

موروث من ChatClient.on

startRealtimeNotifications()

ابدأ في تلقي الإعلامات في الوقت الحقيقي. قم باستدعاء هذه الدالة قبل الاشتراك في أي حدث.

function startRealtimeNotifications(): Promise<void>

المرتجعات

Promise<void>

موروثة من ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

إيقاف تلقي الإعلامات في الوقت الحقيقي. ستقوم هذه الدالة بإلغاء الاشتراك في جميع الأحداث.

function stopRealtimeNotifications(): Promise<void>

المرتجعات

Promise<void>

موروث من ChatClient.stopRealtimeNotifications