AgentNotification الفصل

معالج إشعارات العامل من تطبيقات Microsoft 365.

توفر هذه الفئة مصممات لتسجيل المعالجات التي تستجيب للإعلامات من مختلف قنوات Microsoft 365 والقنوات الفرعية. وهو يدعم التوجيه استنادا إلى معرف القناة والقنوات الفرعية وأحداث دورة الحياة.

الدالمنشئ

AgentNotification()

المعلمات

الاسم	الوصف
app مطلوب	مثيل التطبيق الذي سيتعامل مع الإعلامات التي تم توجيهها.
known_subchannels	اختياري قابل للتكبير من القنوات الفرعية المعترف بها. إذا كان بلا، فسيتم تعيينه افتراضيا إلى كافة القيم في قائمة تعداد AgentSubChannel. القيمة الافتراضية: None
known_lifecycle_events	اختياري قابل للتكبير لأحداث دورة الحياة المعترف بها. إذا كان None، فسيتم تعيينه افتراضيا إلى كافة القيم في قائمة تعداد AgentLifecycleEvent. القيمة الافتراضية: None

أمثلة

   from microsoft_agents.hosting import Application
   from microsoft_agents_a365.notifications import AgentNotification

   app = Application()
   notifications = AgentNotification(app)

   @notifications.on_email()
   async def handle_email(context, state, notification):
       email = notification.email
       if email:
           await context.send_activity(f"Received email: {email.id}")

الأساليب

__init__
__new__
on_agent_lifecycle_notification	تسجيل معالج لإشعارات أحداث دورة حياة العامل. يسجل هذا المصمم دالة معالج ليتم استدعاؤها عند حدوث أحداث دورة الحياة، مثل إنشاء المستخدم أو حذفه أو تحديثات إلحاق حمل العمل.
on_agent_notification	تسجيل معالج للإعلامات من قناة وقناة فرعية معينة. يسجل هذا المصمم دالة معالج ليتم استدعاؤها عند تلقي إعلام من القناة المحددة والقناة الفرعية الاختيارية. سيتلقى المعالج برنامج تضمين AgentNotificationActivity مكتوبا.
on_email	تسجيل معالج لإشعارات البريد الإلكتروني في Outlook. هذا مصمم راحة يسجل معالجا للإعلامات من القناة الفرعية للبريد الإلكتروني.
on_excel	سجل معالجا لإعلامات التعليقات في Microsoft Excel. هذا مصمم ملاءمة يسجل معالجا للإعلامات من قناة Excel الفرعية.
on_lifecycle	تسجيل معالج لكافة إعلامات أحداث دورة حياة العامل. هذا مصمم مزخرف ملائم يسجل معالجا لجميع أحداث دورة الحياة باستخدام مطابق حرف البدل "*".
on_powerpoint	تسجيل معالج لإعلامات التعليق في Microsoft PowerPoint (.pptx). هذا مصمم ملاءمة يسجل معالجا للإعلامات من قناة PowerPoint الفرعية.
on_user_created	تسجيل معالج لأحداث دورة حياة إنشاء المستخدم. هذا مصمم ملاءمة يسجل معالجا خصيصا لأحداث إنشاء هوية المستخدم العامل.
on_user_deleted	تسجيل معالج لأحداث دورة حياة حذف المستخدم. هذا مصمم ملاءمة يسجل معالجا خصيصا لأحداث حذف هوية المستخدم العامل.
on_user_workload_onboarding	تسجيل معالج لأحداث تحديث إعداد حمل عمل المستخدم. هذا مصمم ملاءمة يسجل معالجا للأحداث التي تحدث عند تحديث حالة إلحاق حمل عمل المستخدم.
on_word	سجل معالجا لإعلامات تعليق Microsoft Word. هذا مصمم ملاءمة يسجل معالجا للإعلامات من قناة Word الفرعية.

__init__

__init__(app: Any, known_subchannels: Iterable[str | AgentSubChannel] | None = None, known_lifecycle_events: Iterable[str | AgentLifecycleEvent] | None = None)

المعلمات

الاسم	الوصف
app مطلوب	Any
known_subchannels	Iterable[str | AgentSubChannel] | None القيمة الافتراضية: None
known_lifecycle_events	Iterable[str | AgentLifecycleEvent] | None القيمة الافتراضية: None

__new__

__new__(**kwargs)

on_agent_lifecycle_notification

تسجيل معالج لإشعارات أحداث دورة حياة العامل.

يسجل هذا المصمم دالة معالج ليتم استدعاؤها عند حدوث أحداث دورة الحياة، مثل إنشاء المستخدم أو حذفه أو تحديثات إلحاق حمل العمل.

on_agent_lifecycle_notification(lifecycle_event: str, **kwargs: Any)

المعلمات

الاسم	الوصف
lifecycle_event مطلوب	str حدث دورة الحياة للاستماع إليه. استخدم "*" لمطابقة جميع أحداث دورة الحياة، أو حدد حدثا معينا من AgentLifecycleEvent.
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_agent_lifecycle_notification("agenticuseridentitycreated")
   async def handle_user_created(context, state, notification):
       print("New user created")

on_agent_notification

تسجيل معالج للإعلامات من قناة وقناة فرعية معينة.

يسجل هذا المصمم دالة معالج ليتم استدعاؤها عند تلقي إعلام من القناة المحددة والقناة الفرعية الاختيارية. سيتلقى المعالج برنامج تضمين AgentNotificationActivity مكتوبا.

on_agent_notification(channel_id: ChannelId, **kwargs: Any)

المعلمات

الاسم	الوصف
channel_id مطلوب	ChannelId معرف القناة الذي يحدد القناة والقناة الفرعية الاختيارية للاستماع إليها. استخدم "*" كقنوات فرعية لمطابقة جميع القنوات الفرعية.
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   from microsoft_agents.activity import ChannelId

   @notifications.on_agent_notification(
       ChannelId(channel="agents", sub_channel="email")
   )
   async def handle_custom_channel(context, state, notification):
       print(f"Received notification on {notification.channel}/{notification.sub_channel}")

on_email

تسجيل معالج لإشعارات البريد الإلكتروني في Outlook.

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

on_email(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

المعلمات

الاسم	الوصف
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_email()
   async def handle_email(context, state, notification):
       email = notification.email
       if email:
           print(f"Received email: {email.id}")
           response = EmailResponse.create_email_response_activity(
               "<p>Thank you for your email.</p>"
           )
           await context.send_activity(response)

on_excel

سجل معالجا لإعلامات التعليقات في Microsoft Excel.

هذا مصمم ملاءمة يسجل معالجا للإعلامات من قناة Excel الفرعية.

on_excel(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

المعلمات

الاسم	الوصف
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_excel()
   async def handle_excel_comment(context, state, notification):
       comment = notification.wpx_comment
       if comment:
           print(f"Received Excel comment: {comment.comment_id}")

on_lifecycle

تسجيل معالج لكافة إعلامات أحداث دورة حياة العامل.

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

on_lifecycle(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

المعلمات

الاسم	الوصف
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_lifecycle()
   async def handle_any_lifecycle_event(context, state, notification):
       print(f"Lifecycle event type: {notification.notification_type}")

on_powerpoint

تسجيل معالج لإعلامات التعليق في Microsoft PowerPoint (.pptx).

هذا مصمم ملاءمة يسجل معالجا للإعلامات من قناة PowerPoint الفرعية.

on_powerpoint(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

المعلمات

الاسم	الوصف
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_powerpoint()
   async def handle_powerpoint_comment(context, state, notification):
       comment = notification.wpx_comment
       if comment:
           print(f"Received PowerPoint comment: {comment.comment_id}")

on_user_created

تسجيل معالج لأحداث دورة حياة إنشاء المستخدم.

هذا مصمم ملاءمة يسجل معالجا خصيصا لأحداث إنشاء هوية المستخدم العامل.

on_user_created(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

المعلمات

الاسم	الوصف
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_user_created()
   async def handle_user_created(context, state, notification):
       print("New agentic user identity created")

on_user_deleted

تسجيل معالج لأحداث دورة حياة حذف المستخدم.

هذا مصمم ملاءمة يسجل معالجا خصيصا لأحداث حذف هوية المستخدم العامل.

on_user_deleted(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

المعلمات

الاسم	الوصف
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_user_deleted()
   async def handle_user_deleted(context, state, notification):
       print("Agentic user identity deleted")

on_user_workload_onboarding

تسجيل معالج لأحداث تحديث إعداد حمل عمل المستخدم.

هذا مصمم ملاءمة يسجل معالجا للأحداث التي تحدث عند تحديث حالة إلحاق حمل عمل المستخدم.

on_user_workload_onboarding(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

المعلمات

الاسم	الوصف
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_user_workload_onboarding()
   async def handle_onboarding_update(context, state, notification):
       print("User workload onboarding status updated")

on_word

سجل معالجا لإعلامات تعليق Microsoft Word.

هذا مصمم ملاءمة يسجل معالجا للإعلامات من قناة Word الفرعية.

on_word(**kwargs: Any) -> Callable[[Callable[[TContext, TState, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]

المعلمات

الاسم	الوصف
**kwargs مطلوب	Any تم تمرير وسيطات كلمات أساسية إضافية إلى أسلوب add_route التطبيق.

المرتجعات

النوع	الوصف
Callable[[Callable[[<xref:microsoft_agents_a365.notifications.agent_notification.TContext>, <xref:microsoft_agents_a365.notifications.agent_notification.TState>, AgentNotificationActivity], Awaitable[None]]], Callable[[TurnContext, TurnState], Awaitable[None]]]	دالة مصمم تسجل المعالج مع التطبيق.

أمثلة

   @notifications.on_word()
   async def handle_word_comment(context, state, notification):
       comment = notification.wpx_comment
       if comment:
           print(f"Received Word comment: {comment.comment_id}")