ActivityHandler الفصل

يعالج الأنشطة ويجب أن يكون مصنفا من فئة فرعية.

الدالمنشئ

ActivityHandler()

الملاحظات

اشتقاق من هذه الفئة لمعالجة أنواع نشاط معينة. يمكن ل Yon إضافة المعالجة المسبقة واللاحقة للأنشطة عن طريق استدعاء الفئة الأساسية في الفئة المشتقة.

الأساليب

on_adaptive_card_invoke

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

عندما يتلقى أسلوب on_invoke_activity استدعاء مع Activity.name adaptiveCard/action، فإنه يستدعي هذا الأسلوب.

on_conversation_update_activity

يتم استدعاؤه عند تلقي نشاط تحديث محادثة من القناة عند استخدام السلوك الأساسي on_turn.

on_end_of_conversation_activity

يتم استدعاؤه عند تلقي نشاط انتهاء محادثة من القناة.

on_event

يتم استدعاؤه عند تلقي حدث آخر غير الرموز المميزة/الاستجابة عند استخدام السلوك الأساسي on_event_activity.

on_event_activity

يتم استدعاؤه عند تلقي نشاط حدث من الموصل عند استخدام السلوك الأساسي on_turn.

on_installation_update

تجاوز هذا في فئة مشتقة لتوفير منطق خاص بأنشطة ActivityTypes.InstallationUpdate.

on_installation_update_add

تجاوز هذا في فئة مشتقة لتوفير منطق خاص بأنشطة ActivityTypes.InstallationUpdate مع تعيين "الإجراء" إلى "إضافة".

on_installation_update_remove

تجاوز هذا في فئة مشتقة لتوفير منطق خاص بأنشطة ActivityTypes.InstallationUpdate مع تعيين "الإجراء" إلى "إزالة".

on_invoke_activity

تسجيل معالج حدث نشاط لحدث استدعاء، المنبعثة لكل نشاط حدث وارد.

on_members_added_activity

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

نشاط تحديث المحادثة :اكتب members_added: List :p aram turn_context: كائن السياق لهذا الدور :اكتب turn_context: TurnContext

on_members_removed_activity

تجاوز هذا الأسلوب في فئة مشتقة لتوفير منطق عندما يغادر الأعضاء غير الروبوت المحادثة. يمكنك إضافة منطق الوداعا للروبوت الخاص بك.

نشاط تحديث المحادثة :اكتب members_added: List :p aram turn_context: كائن السياق لهذا الدور :اكتب turn_context: TurnContext

on_message_activity

تجاوز هذا الأسلوب في فئة مشتقة لتوفير منطق خاص بالأنشطة، مثل منطق المحادثة.

on_message_reaction_activity

يتم استدعاؤه عند تلقي نشاط حدث من الموصل عند استخدام السلوك الأساسي on_turn.

on_reactions_added

تجاوز هذا الأسلوب في فئة مشتقة لتوفير منطق عند إضافة ردود الفعل على نشاط سابق إلى المحادثة.

on_reactions_removed

تجاوز هذا الأسلوب في فئة مشتقة لتوفير منطق عند إزالة ردود الفعل على نشاط سابق من المحادثة.

on_sign_in_invoke

يتم استدعاؤه عند تلقي حدث signin/verifyState أو signin/tokenExchange عند استخدام السلوك الأساسي on_invoke_activity(TurnContext{InvokeActivity}). إذا كنت تستخدم OAuthPrompt، فتجاوز هذا الأسلوب لإعادة توجيه هذا النشاط"/ إلى مربع الحوار الحالي. بشكل افتراضي، لا يفعل هذا الأسلوب شيئا.

on_token_response_event

يتم استدعاؤه عند تلقي حدث الرموز المميزة/الاستجابة عند استخدام السلوك الأساسي on_event_activity. إذا كنت تستخدم oauth_prompt، فتجاوز هذا الأسلوب لإعادة توجيه هذا النشاط إلى مربع الحوار الحالي.

on_turn

يتم استدعاؤه بواسطة المحول (على سبيل المثال، <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) في وقت التشغيل لمعالجة Activityواردة.

on_typing_activity

تجاوز هذا في فئة مشتقة لتوفير منطق خاص بأنشطة ActivityTypes.typing، مثل منطق المحادثة.

on_unrecognized_activity_type

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

on_adaptive_card_invoke

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

عندما يتلقى أسلوب on_invoke_activity استدعاء مع Activity.name adaptiveCard/action، فإنه يستدعي هذا الأسلوب.

async on_adaptive_card_invoke(turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue) -> AdaptiveCardInvokeResponse

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن سياق لهذا الدور.

invoke_value
مطلوب
<xref:botframework.schema.models.AdaptiveCardInvokeValue>

كائن مكتوب بسلسلة من قيمة النشاط الوارد.

المرتجعات

النوع الوصف

كائن HealthCheckResponse

on_conversation_update_activity

يتم استدعاؤه عند تلقي نشاط تحديث محادثة من القناة عند استخدام السلوك الأساسي on_turn.

async on_conversation_update_activity(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

عندما يتلقى أسلوب on_turn نشاط تحديث محادثة، فإنه يستدعي هذا الأسلوب. أيضًا

  • إذا كان نشاط تحديث المحادثة يشير إلى أن أعضاء غير الروبوت انضموا إلى المحادثة، فإنه يستدعي أسلوب on_members_added_activity.
  • إذا كان نشاط تحديث المحادثة يشير إلى أن أعضاء غير الروبوت غادروا المحادثة، فإنه يستدعي أسلوب on_members_removed_activity.
  • في فئة مشتقة، تجاوز هذا الأسلوب لإضافة منطق ينطبق على جميع أنشطة تحديث المحادثة. أضف منطقا لتطبيقه قبل أن يضيف العضو منطقا أو يزيله قبل استدعاء أسلوب الفئة الأساسية هذا.

on_end_of_conversation_activity

يتم استدعاؤه عند تلقي نشاط انتهاء محادثة من القناة.

async on_end_of_conversation_activity(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

on_event

يتم استدعاؤه عند تلقي حدث آخر غير الرموز المميزة/الاستجابة عند استخدام السلوك الأساسي on_event_activity.

async on_event(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

عند استخدام أسلوب on_event_activity يتلقى حدثا باسم نشاط آخر غير الرموز المميزة/الاستجابة، فإنه يستدعي هذا الأسلوب. يمكن تجاوز هذا الأسلوب اختياريا إذا كان الهدف من الروبوت معالجة الأحداث المتنوعة.

on_event_activity

يتم استدعاؤه عند تلقي نشاط حدث من الموصل عند استخدام السلوك الأساسي on_turn.

async on_event_activity(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

عندما يتلقى الأسلوب on_turn نشاط حدث، فإنه يستدعي هذا الأسلوب. إذا كان اسم النشاط الرموز المميزة/الاستجابة، فإنه يستدعي on_token_response_event؛ وإلا، فإنه يستدعي on_event.

في فئة مشتقة، تجاوز هذا الأسلوب لإضافة منطق ينطبق على جميع أنشطة الحدث. أضف منطقا لتطبيقه قبل منطق معالجة الحدث المحدد قبل استدعاء أسلوب الفئة الأساسية هذا. أضف منطقا لتطبيقه بعد منطق معالجة الحدث المحدد بعد استدعاء أسلوب الفئة الأساسية هذا.

تنقل أنشطة الحدث معلومات برمجية من عميل أو قناة إلى روبوت. يتم تعريف معنى نشاط الحدث بواسطة خاصية اسم نشاط الحدث، والتي تكون ذات معنى ضمن نطاق القناة.

on_installation_update

تجاوز هذا في فئة مشتقة لتوفير منطق خاص بأنشطة ActivityTypes.InstallationUpdate.

async on_installation_update(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

on_installation_update_add

تجاوز هذا في فئة مشتقة لتوفير منطق خاص بأنشطة ActivityTypes.InstallationUpdate مع تعيين "الإجراء" إلى "إضافة".

async on_installation_update_add(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

on_installation_update_remove

تجاوز هذا في فئة مشتقة لتوفير منطق خاص بأنشطة ActivityTypes.InstallationUpdate مع تعيين "الإجراء" إلى "إزالة".

async on_installation_update_remove(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

on_invoke_activity

تسجيل معالج حدث نشاط لحدث استدعاء، المنبعثة لكل نشاط حدث وارد.

async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse | None

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

on_members_added_activity

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

نشاط تحديث المحادثة :اكتب members_added: List :p aram turn_context: كائن السياق لهذا الدور :اكتب turn_context: TurnContext

async on_members_added_activity(members_added: List[ChannelAccount], turn_context: TurnContext)

المعلمات

الاسم الوصف
members_added
مطلوب
turn_context
مطلوب

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

عندما يتلقى أسلوب on_conversation_update_activity نشاط تحديث محادثة يشير إلى أن مستخدما واحدا أو أكثر غير الروبوت ينضم إلى المحادثة، فإنه يستدعي هذا الأسلوب.

on_members_removed_activity

تجاوز هذا الأسلوب في فئة مشتقة لتوفير منطق عندما يغادر الأعضاء غير الروبوت المحادثة. يمكنك إضافة منطق الوداعا للروبوت الخاص بك.

نشاط تحديث المحادثة :اكتب members_added: List :p aram turn_context: كائن السياق لهذا الدور :اكتب turn_context: TurnContext

async on_members_removed_activity(members_removed: List[ChannelAccount], turn_context: TurnContext)

المعلمات

الاسم الوصف
members_removed
مطلوب
turn_context
مطلوب

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

عندما يتلقى أسلوب on_conversation_update_activity نشاط تحديث محادثة يشير إلى أن مستخدما واحدا أو أكثر غير الروبوت يغادر المحادثة، فإنه يستدعي هذا الأسلوب.

on_message_activity

تجاوز هذا الأسلوب في فئة مشتقة لتوفير منطق خاص بالأنشطة، مثل منطق المحادثة.

async on_message_activity(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

on_message_reaction_activity

يتم استدعاؤه عند تلقي نشاط حدث من الموصل عند استخدام السلوك الأساسي on_turn.

async on_message_reaction_activity(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

تتوافق تفاعلات الرسائل مع المستخدم الذي يضيف "مثل" أو "حزين" وما إلى ذلك (غالبا رمز مشاعر) إلى نشاط تم إرساله مسبقا.

يتم دعم تفاعلات الرسائل فقط من قبل عدد قليل من القنوات. تتم الإشارة إلى النشاط الذي يتوافق مع رد فعل الرسالة في خاصية الرد على المعرف. قيمة هذه الخاصية هي معرف النشاط لنشاط تم إرساله مسبقا معطاة مرة أخرى إلى الروبوت كاستجابة من مكالمة إرسال. عندما يتلقى الأسلوب on_turn نشاط رد فعل رسالة، فإنه يستدعي هذا الأسلوب.

  • إذا كان رد فعل الرسالة يشير إلى أنه تمت إضافة ردود الفعل إلى رسالة، فإنه يستدعي

<xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_added>.

  • إذا كان رد فعل الرسالة يشير إلى أنه تمت إزالة ردود الفعل من رسالة، فإنه يستدعي <xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>.

في فئة مشتقة، تجاوز هذا الأسلوب لإضافة منطق ينطبق على جميع أنشطة تفاعل الرسالة. أضف منطقا لتطبيقه قبل أن تضيف التفاعلات المنطق أو تزيله قبل استدعاء أسلوب الفئة الأساسية هذا. أضف منطقا لتطبيقه بعد إضافة ردود الفعل أو إزالتها منطق بعد الاستدعاء إلى أسلوب الفئة الأساسية هذا.

on_reactions_added

تجاوز هذا الأسلوب في فئة مشتقة لتوفير منطق عند إضافة ردود الفعل على نشاط سابق إلى المحادثة.

async on_reactions_added(message_reactions: List[MessageReaction], turn_context: TurnContext)

المعلمات

الاسم الوصف
message_reactions
مطلوب

تمت إضافة قائمة التفاعلات

turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

تتوافق تفاعلات الرسائل مع المستخدم الذي يضيف "مثل" أو "حزين" وما إلى ذلك (غالبا رمز مشاعر) إلى رسالة تم إرسالها مسبقا في المحادثة. يتم دعم تفاعلات الرسائل من قبل عدد قليل من القنوات فقط. يتم تحديد النشاط الذي ترد عليه الرسالة من خلال رد النشاط على خاصية المعرف. قيمة هذه الخاصية هي معرف النشاط لنشاط تم إرساله مسبقا. عندما يرسل الروبوت نشاطا، تعين القناة معرفا له، والذي يتوفر في معرف استجابة المورد للنتيجة.

on_reactions_removed

تجاوز هذا الأسلوب في فئة مشتقة لتوفير منطق عند إزالة ردود الفعل على نشاط سابق من المحادثة.

async on_reactions_removed(message_reactions: List[MessageReaction], turn_context: TurnContext)

المعلمات

الاسم الوصف
message_reactions
مطلوب

قائمة ردود الفعل التي تمت إزالتها

turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

تتوافق تفاعلات الرسائل مع المستخدم الذي يضيف "مثل" أو "حزين" وما إلى ذلك (غالبا رمز مشاعر) إلى رسالة تم إرسالها مسبقا في المحادثة. يتم دعم تفاعلات الرسائل من قبل عدد قليل من القنوات فقط. يتم تحديد النشاط الذي ترد عليه الرسالة من خلال رد النشاط على خاصية المعرف. قيمة هذه الخاصية هي معرف النشاط لنشاط تم إرساله مسبقا. عندما يرسل الروبوت نشاطا، تعين القناة معرفا له، والذي يتوفر في معرف استجابة المورد للنتيجة.

on_sign_in_invoke

يتم استدعاؤه عند تلقي حدث signin/verifyState أو signin/tokenExchange عند استخدام السلوك الأساسي on_invoke_activity(TurnContext{InvokeActivity}). إذا كنت تستخدم OAuthPrompt، فتجاوز هذا الأسلوب لإعادة توجيه هذا النشاط"/ إلى مربع الحوار الحالي. بشكل افتراضي، لا يفعل هذا الأسلوب شيئا.

async on_sign_in_invoke(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

on_token_response_event

يتم استدعاؤه عند تلقي حدث الرموز المميزة/الاستجابة عند استخدام السلوك الأساسي on_event_activity. إذا كنت تستخدم oauth_prompt، فتجاوز هذا الأسلوب لإعادة توجيه هذا النشاط إلى مربع الحوار الحالي.

async on_token_response_event(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

عندما يتلقى أسلوب on_event حدثا باسم نشاط الرموز المميزة/الاستجابة، فإنه يستدعي هذا الأسلوب. إذا كان الروبوت الخاص بك يستخدم oauth_prompt، فقم بإعادة توجيه النشاط الوارد إلى مربع الحوار الحالي.

on_turn

يتم استدعاؤه بواسطة المحول (على سبيل المثال، <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) في وقت التشغيل لمعالجة Activityواردة.

async on_turn(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

يستدعي أساليب أخرى في هذه الفئة استنادا إلى نوع النشاط المراد معالجته، والذي يسمح لفئة مشتقة بتوفير منطق خاص بالنوع بطريقة خاضعة للرقابة. في فئة مشتقة، تجاوز هذا الأسلوب لإضافة منطق ينطبق على جميع أنواع النشاط. أيضًا

  • أضف منطقا لتطبيقه قبل المنطق الخاص بالنوع وقبل استدعاء on_turn.
  • أضف منطقا لتطبيقه بعد المنطق الخاص بالنوع بعد استدعاء on_turn.

on_typing_activity

تجاوز هذا في فئة مشتقة لتوفير منطق خاص بأنشطة ActivityTypes.typing، مثل منطق المحادثة.

async on_typing_activity(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

on_unrecognized_activity_type

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

async on_unrecognized_activity_type(turn_context: TurnContext)

المعلمات

الاسم الوصف
turn_context
مطلوب

كائن السياق لهذا الدور

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

الملاحظات

عندما يتلقى أسلوب on_turn نشاطا ليس رسالة أو تحديث محادثة أو تفاعل رسالة أو نشاط حدث، فإنه يستدعي هذا الأسلوب.