AgentNotification คลาส

ตัวจัดการสําหรับการแจ้งเตือนตัวแทนจากแอปพลิเคชัน Microsoft 365

ระดับนี้จัดเตรียมตกแต่งสําหรับการลงทะเบียนตัวจัดการที่ตอบสนองต่อการแจ้งเตือนจากช่องทางและแชนเนลย่อยต่างๆ ของ Microsoft 365 ซึ่งสนับสนุนการกําหนดเส้นทางตามเหตุการณ์ ID ช่อง แชนเนลย่อย และวงจรชีวิต

คอนสตรักเตอร์

AgentNotification()

พารามิเตอร์

ชื่อ	คำอธิบาย
app จำเป็น	อินสแตนซ์ของแอพลิเคชันที่จะจัดการการแจ้งเตือนที่ถูกกําหนดเส้นทาง
known_subchannels	สามารถซ้ําได้ของช่องย่อยที่รู้จัก ถ้าไม่มี ค่าเริ่มต้นคือค่าทั้งหมดใน Enum AgentSubChannel Default value: None
known_lifecycle_events	สามารถวนซ้ําได้ของเหตุการณ์วงจรชีวิตที่รู้จัก หากไม่มี ค่าเริ่มต้นคือค่าทั้งหมดใน Enum AgentLifecycleEvent Default value: 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 นี่คือผู้ตกแต่งความสะดวกสบายที่ลงทะเบียนตัวจัดการสําหรับการแจ้งเตือนจากแชนเนลย่อยของ 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 Default value: None
known_lifecycle_events	Iterable[str | AgentLifecycleEvent] | None Default value: 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 ID ช่องที่ระบุช่องและช่องย่อยที่เลือกได้เพื่อฟัง ใช้ "*" เป็นช่องย่อยเพื่อจับคู่ช่องย่อยทั้งหมด
**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

นี่คือผู้ตกแต่งความสะดวกสบายที่ลงทะเบียนตัวจัดการสําหรับการแจ้งเตือนจากแชนเนลย่อยของ 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}")