AgentNotificationActivity Klasa

Otoka wokół obiektu Działania z typowymi jednostkami powiadomień.

Ta klasa zapewnia wygodny dostęp do typowych jednostek powiadomień wyodrębnionych z kolekcji jednostek działania. Automatycznie analizuje i weryfikuje powiadomienia e-mail, komentarze programu Word/PowerPoint/Excel i zdarzenia cyklu życia w czasie budowy.

Konstruktor

AgentNotificationActivity()

Parametry

Nazwa Opis
activity
Wymagane

Obiekt Activity do opakowania. Nie może być brak.

Przykłady


   async def email_handler(
       context: TurnContext,
       state: TurnState,
       notification: AgentNotificationActivity,
   ) -> None:
       email = notification.email
       if email:
           print(f"Received email: {email.id}")
           print(f"Body: {email.html_body}")

Metody

__init__
__new__
as_model

Przeanalizuj wartość działania jako typ modelu niestandardowego.

Ta metoda zapewnia ogólny sposób sprawdzania poprawności i analizowania ładunku wartości działania do dowolnego typu modelu Pydantic. Przydatne w przypadku niestandardowych typów powiadomień nieobsługiwanych bezpośrednio przez typizowane właściwości.

__init__

__init__(activity: Activity)

Parametry

Nazwa Opis
activity
Wymagane

__new__

__new__(**kwargs)

as_model

Przeanalizuj wartość działania jako typ modelu niestandardowego.

Ta metoda zapewnia ogólny sposób sprawdzania poprawności i analizowania ładunku wartości działania do dowolnego typu modelu Pydantic. Przydatne w przypadku niestandardowych typów powiadomień nieobsługiwanych bezpośrednio przez typizowane właściwości.

as_model(model: Type[TModel]) -> TModel | None

Parametry

Nazwa Opis
model
Wymagane
Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]

Klasa modelu Pydantic do weryfikowania i analizowania wartości działania.

Zwraca

Typ Opis
<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel> | None

Wystąpienie określonego typu modelu, jeśli walidacja zakończy się pomyślnie, w przeciwnym razie Brak.

Przykłady


   from pydantic import BaseModel

   class CustomNotification(BaseModel):
       custom_field: str

   notification = AgentNotificationActivity(activity)
   custom = notification.as_model(CustomNotification)
   if custom:
       print(custom.custom_field)

Atrybuty

channel

Identyfikator kanału z channel_id działania.

Zwraca

Typ Opis

Nazwa kanału (np. "agenci", "msteams") lub Brak, jeśli nie jest dostępna.

email

Analizowana jednostka odwołania do wiadomości e-mail, jeśli jest obecna.

Zwraca

Typ Opis

Obiekt EmailReference, jeśli jednostka powiadomienia e-mail została znaleziona i pomyślnie przeanalizowana, w przeciwnym razie Brak.

notification_type

Wykryty typ powiadomienia.

Zwraca

Typ Opis

Wartość wyliczenia NotificationTypes wskazująca typ powiadomienia (EMAIL_NOTIFICATION, WPX_COMMENT lub AGENT_LIFECYCLE) lub Brak, jeśli nie można określić typu powiadomienia.

sub_channel

Identyfikator podrzędnego kanału z channel_id działania.

Zwraca

Typ Opis

Nazwa podkanału (np. "email", "word") lub Brak, jeśli nie jest dostępna.

type

Typ działania.

Zwraca

Typ Opis

Typ działania (np. "message", "event" lub None, jeśli nie jest ustawiony.

value

Ładunek wartości z działania.

Zwraca

Typ Opis

Wartość działania, która może zawierać dodatkowe dane powiadomień.

wpx_comment

Analizowana jednostka komentarza Word/PowerPoint/Excel, jeśli jest obecna.

Zwraca

Typ Opis

Obiekt WpxComment, jeśli jednostka komentarza została znaleziona i pomyślnie przeanalizowana, w przeciwnym razie Brak.

activity

Bazowy obiekt Działania.