AgentNotification Κλάση

Χειρισμός για ειδοποιήσεις αντιπροσώπων από εφαρμογές Του Microsoft 365.

Αυτή η κλάση παρέχει διακοσμητές για την εγγραφή διαχειριστών που ανταποκρίνονται σε ειδοποιήσεις από διάφορα κανάλια και υποκανάυλα του Microsoft 365. Υποστηρίζει δρομολόγηση με βάση το αναγνωριστικό καναλιού, το υποκανάλη και τα συμβάντα κύκλου ζωής.

Κατασκευή

AgentNotification()

Παράμετροι

Όνομα Περιγραφή
app
Απαιτείται

Η παρουσία εφαρμογής που θα χειρίζεται τις δρομολογημένες ειδοποιήσεις.

known_subchannels

Προαιρετικό επαναλήπσιμο των αναγνωρισμένων υποκαναλικών καναλιών. Εάν δεν υπάρχει, λαμβάνει από προεπιλογή όλες τις τιμές στην απαρίθμηση AgentSubChannel.

Default value: None
known_lifecycle_events

Προαιρετικό επαναλήπσιμο από αναγνωρισμένα συμβάντα κύκλου ζωής. Εάν δεν υπάρχει, η προεπιλογή είναι όλες οι τιμές στην απαρίθμηση 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

Καταχωρήστε έναν χειρισμό για συμβάντα κύκλου ζωής διαγραφής χρηστών.

Αυτός είναι ένας διακοσμητής ευκολίας που καταχωρεί έναν χειρισμό ειδικά για συμβάντα διαγραφής ταυτότητας agentic user.

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
Default value: None
known_lifecycle_events
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 της εφαρμογής.

Επιστροφές

Τύπος Περιγραφή

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   @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
Απαιτείται

Το αναγνωριστικό καναλιού που καθορίζει το κανάλι και το προαιρετικό υποκανάλη για ακρόαση. Χρησιμοποιήστε το "*" ως υποκανάλη για να αντιστοιχοποιήσετε όλα τα υποκαναλτικά.

**kwargs
Απαιτείται
Any

Πρόσθετα ορίσματα λέξεων-κλειδιών που διαβιβάζονται στη μέθοδο add_route της εφαρμογής.

Επιστροφές

Τύπος Περιγραφή

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   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]]]

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   @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]]]

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   @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]]]

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   @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]]]

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   @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]]]

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


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

on_user_deleted

Καταχωρήστε έναν χειρισμό για συμβάντα κύκλου ζωής διαγραφής χρηστών.

Αυτός είναι ένας διακοσμητής ευκολίας που καταχωρεί έναν χειρισμό ειδικά για συμβάντα διαγραφής ταυτότητας agentic user.

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]]]

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   @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]]]

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   @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]]]

Μια συνάρτηση decorator που καταχωρεί τον χειρισμό στην εφαρμογή.

Παραδείγματα


   @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}")