AgentNotification Klas

Handler voor agentmeldingen van Microsoft 365-toepassingen.

Deze klasse biedt decorators voor het registreren van handlers die reageren op meldingen van verschillende Microsoft 365-kanalen en subkanalen. Het biedt ondersteuning voor routering op basis van kanaal-id-, subkanaal- en levenscyclusgebeurtenissen.

Constructor

AgentNotification()

Parameters

Naam	Description
app Vereist	Het toepassingsexemplaren waarmee de gerouteerde meldingen worden verwerkt.
known_subchannels	Optioneel itereerbaar van herkende subkanalen. Als geen, wordt standaard ingesteld op alle waarden in de enum AgentSubChannel. Default value: None
known_lifecycle_events	Optioneel itereerbaar van herkende levenscyclus-gebeurtenissen. Als geen, wordt standaard alle waarden in de AgentLifecycleEvent enum ingesteld. Default value: None

Voorbeelden

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

Methoden

__init__
__new__
on_agent_lifecycle_notification	Registreer een handler voor gebeurtenismeldingen voor de levenscyclus van agents. Deze decorator registreert een handler-functie die moet worden aangeroepen wanneer er levenscyclus-gebeurtenissen plaatsvinden, zoals het maken, verwijderen of onboarden van workloads.
on_agent_notification	Registreer een handler voor meldingen van een specifiek kanaal en subkanaal. Deze decorator registreert een handler-functie die moet worden aangeroepen wanneer een melding wordt ontvangen van het opgegeven kanaal en optionele subkanaal. De handler ontvangt een getypte AgentNotificationActivity-wrapper.
on_email	Registreer een handler voor e-mailmeldingen van Outlook. Dit is een handige decorator die een handler registreert voor meldingen van het e-mailsubkanaal.
on_excel	Registreer een handler voor opmerkingenmeldingen van Microsoft Excel. Dit is een handige decorator die een handler registreert voor meldingen van het Excel-subkanaal.
on_lifecycle	Registreer een handler voor alle meldingen over de levenscyclus van agents. Dit is een handige decorator die een handler registreert voor alle levenscyclus-gebeurtenissen met behulp van de jokerteken '*'-matcher.
on_powerpoint	Registreer een handler voor opmerkingenmeldingen van Microsoft PowerPoint. Dit is een handige decorator die een handler registreert voor meldingen van het PowerPoint-subkanaal.
on_user_created	Registreer een handler voor levenscyclus-gebeurtenissen voor het maken van gebruikers. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het maken van agentische gebruikersidentiteiten.
on_user_deleted	Registreer een handler voor levenscyclus-gebeurtenissen voor het verwijderen van gebruikers. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het verwijderen van agentische gebruikersidentiteiten.
on_user_disabled	Registreer een handler voor door de gebruiker uitgeschakelde levenscyclusgebeurtenissen. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor agentische gebruikers uitgeschakelde gebeurtenissen.
on_user_enabled	Registreer een handler voor levenscyclus-gebeurtenissen die door de gebruiker zijn ingeschakeld. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen met agentische gebruikers.
on_user_manager_updated	Registreer een handler voor bijgewerkte levenscyclus-gebeurtenissen van user manager. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor agentic user manager bijgewerkte gebeurtenissen.
on_user_undeleted	Registreer een handler voor levenscyclusgebeurtenissen van gebruikers die de verwijdering ongedaan maken. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het verwijderen van agentische gebruikersidentiteiten.
on_user_updated	Registreer een handler voor door de gebruiker bijgewerkte levenscyclus-gebeurtenissen. Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor bijgewerkte gebeurtenissen voor agentische gebruikersidentiteiten.
on_user_workload_onboarding	Registreer een handler voor onboarding van update-gebeurtenissen voor gebruikersworkloads. Dit is een handige decorator die een handler registreert voor gebeurtenissen die optreden wanneer de onboardingstatus van een gebruiker wordt bijgewerkt.
on_word	Registreer een handler voor opmerkingenmeldingen van Microsoft Word. Dit is een handige decorator die een handler registreert voor meldingen van het Word-subkanaal.

__init__

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

Parameters

Naam	Description
app Vereist	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

Registreer een handler voor gebeurtenismeldingen voor de levenscyclus van agents.

Deze decorator registreert een handler-functie die moet worden aangeroepen wanneer er levenscyclus-gebeurtenissen plaatsvinden, zoals het maken, verwijderen of onboarden van workloads.

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

Parameters

Naam	Description
lifecycle_event Vereist	str De levenscyclus-gebeurtenis om naar te luisteren. Gebruik *om alle levenscyclus-gebeurtenissen te vinden of geef een specifieke gebeurtenis op van AgentLifecycleEvent.
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

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

on_agent_notification

Registreer een handler voor meldingen van een specifiek kanaal en subkanaal.

Deze decorator registreert een handler-functie die moet worden aangeroepen wanneer een melding wordt ontvangen van het opgegeven kanaal en optionele subkanaal. De handler ontvangt een getypte AgentNotificationActivity-wrapper.

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

Parameters

Naam	Description
channel_id Vereist	ChannelId De kanaal-id waarmee het kanaal en optionele subkanaal worden opgegeven om naar te luisteren. Gebruik *als subkanaal om alle subkanalen te vinden.
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

   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

Registreer een handler voor e-mailmeldingen van Outlook.

Dit is een handige decorator die een handler registreert voor meldingen van het e-mailsubkanaal.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

   @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

Registreer een handler voor opmerkingenmeldingen van Microsoft Excel.

Dit is een handige decorator die een handler registreert voor meldingen van het Excel-subkanaal.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

   @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

Registreer een handler voor alle meldingen over de levenscyclus van agents.

Dit is een handige decorator die een handler registreert voor alle levenscyclus-gebeurtenissen met behulp van de jokerteken '*'-matcher.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

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

on_powerpoint

Registreer een handler voor opmerkingenmeldingen van Microsoft PowerPoint.

Dit is een handige decorator die een handler registreert voor meldingen van het PowerPoint-subkanaal.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

   @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

Registreer een handler voor levenscyclus-gebeurtenissen voor het maken van gebruikers.

Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het maken van agentische gebruikersidentiteiten.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

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

on_user_deleted

Registreer een handler voor levenscyclus-gebeurtenissen voor het verwijderen van gebruikers.

Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het verwijderen van agentische gebruikersidentiteiten.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

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

on_user_disabled

Registreer een handler voor door de gebruiker uitgeschakelde levenscyclusgebeurtenissen.

Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor agentische gebruikers uitgeschakelde gebeurtenissen.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

''<<>>'<<python @notifications.on_user_disabled() async def handle_user_disabled(context, status, melding):

print("Agentic user disabled")

''<<>>'<<

on_user_enabled

Registreer een handler voor levenscyclus-gebeurtenissen die door de gebruiker zijn ingeschakeld.

Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen met agentische gebruikers.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

''<<>>'<<python @notifications.on_user_enabled() async def handle_user_enabled(context, status, melding):

print("Agentic user enabled")

''<<>>'<<

on_user_manager_updated

Registreer een handler voor bijgewerkte levenscyclus-gebeurtenissen van user manager.

Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor agentic user manager bijgewerkte gebeurtenissen.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

''<<>>'<<python @notifications.on_user_manager_updated() async def handle_user_manager_updated(context, status, melding):

print("Agentic user manager updated")

''<<>>'<<

on_user_undeleted

Registreer een handler voor levenscyclusgebeurtenissen van gebruikers die de verwijdering ongedaan maken.

Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor gebeurtenissen voor het verwijderen van agentische gebruikersidentiteiten.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

''<<>>'<<python @notifications.on_user_undeleted() async def handle_user_undeleted(context, status, melding):

print("Agentic user identity un-deleted")

''<<>>'<<

on_user_updated

Registreer een handler voor door de gebruiker bijgewerkte levenscyclus-gebeurtenissen.

Dit is een handige decorator waarmee een handler specifiek wordt geregistreerd voor bijgewerkte gebeurtenissen voor agentische gebruikersidentiteiten.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

''<<>>'<<python @notifications.on_user_updated() async def handle_user_updated(context, status, melding):

print("Agentic user identity updated")

''<<>>'<<

on_user_workload_onboarding

Registreer een handler voor onboarding van update-gebeurtenissen voor gebruikersworkloads.

Dit is een handige decorator die een handler registreert voor gebeurtenissen die optreden wanneer de onboardingstatus van een gebruiker wordt bijgewerkt.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

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

on_word

Registreer een handler voor opmerkingenmeldingen van Microsoft Word.

Dit is een handige decorator die een handler registreert voor meldingen van het Word-subkanaal.

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

Parameters

Naam	Description
**kwargs Vereist	Any Aanvullende trefwoordargumenten die zijn doorgegeven aan de add_route methode van de app.

Retouren

Type	Description
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]]]	Een decoratorfunctie waarmee de handler wordt geregistreerd bij de toepassing.

Voorbeelden

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