AgentNotificationActivity Klasse

Wrapper um ein Activity-Objekt mit typierten Benachrichtigungsentitäten.

Diese Klasse bietet bequemen Zugriff auf typierte Benachrichtigungsentitäten, die aus der Entitätensammlung einer Aktivität extrahiert wurden. Es analysiert und überprüft E-Mail-Benachrichtigungen, Word/PowerPoint/Excel-Kommentare und Lebenszyklusereignisse zur Erstellungszeit automatisch.

Konstruktor

AgentNotificationActivity()

Parameter

Name Beschreibung
activity
Erforderlich

Das aktivitätsobjekt, das umbrochen werden soll. Darf keine sein.

Beispiele

'''<<>><<python async def email_handler(context: TurnContext, state: TurnState, notification: AgentNotificationActivity):

email = notification.email wenn E-Mail:

  print(f"Received email: {email.id}")
  print(f"Body: {email.html_body}")

'''<<>><<

Methoden

__init__
__new__
as_model

Analysieren Sie den Aktivitätswert als benutzerdefinierter Modelltyp.

Diese Methode bietet eine allgemeine Möglichkeit zum Überprüfen und Analysieren der Wertnutzlast der Aktivität in jeden pydantischen Modelltyp. Nützlich für benutzerdefinierte Benachrichtigungstypen, die von den typierten Eigenschaften nicht direkt unterstützt werden.

__init__

__init__(activity: Activity)

Parameter

Name Beschreibung
activity
Erforderlich

__new__

__new__(**kwargs)

as_model

Analysieren Sie den Aktivitätswert als benutzerdefinierter Modelltyp.

Diese Methode bietet eine allgemeine Möglichkeit zum Überprüfen und Analysieren der Wertnutzlast der Aktivität in jeden pydantischen Modelltyp. Nützlich für benutzerdefinierte Benachrichtigungstypen, die von den typierten Eigenschaften nicht direkt unterstützt werden.

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

Parameter

Name Beschreibung
model
Erforderlich
Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]

Eine Pydantische Modellklasse zum Überprüfen und Analysieren des Aktivitätswerts.

Gibt zurück

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

Eine Instanz des angegebenen Modelltyps, wenn die Überprüfung erfolgreich ist, andernfalls None.

Beispiele

''<<>><<Python aus pydantischem Import BaseModel

class CustomNotification(BaseModel): custom_field: str

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

print(custom.custom_field)

'''<<>><<

Attribute

channel

Der Kanalbezeichner aus der channel_id der Aktivität.

Gibt zurück

Typ Beschreibung

Der Kanalname (z. B. "Agents", "msteams") oder "None", falls nicht verfügbar.

email

Die analysierte E-Mail-Referenzentität, sofern vorhanden.

Gibt zurück

Typ Beschreibung

Ein EmailReference-Objekt, wenn eine E-Mail-Benachrichtigungsentität gefunden und erfolgreich analysiert wurde, andernfalls None.

notification_type

Der erkannte Benachrichtigungstyp.

Gibt zurück

Typ Beschreibung

Der Enumerationswert NotificationTypes, der den Typ der Benachrichtigung angibt (EMAIL_NOTIFICATION, WPX_COMMENT oder AGENT_LIFECYCLE), oder "None", wenn der Benachrichtigungstyp nicht bestimmt werden konnte.

sub_channel

Der Subkanalbezeichner aus der channel_id der Aktivität.

Gibt zurück

Typ Beschreibung

Der Unterkanalname (z. B. "E-Mail", "Wort") oder "None", falls nicht verfügbar.

type

Der Aktivitätstyp.

Gibt zurück

Typ Beschreibung

Der Typ der Aktivität (z. B. "Nachricht", "Ereignis") oder "None", falls nicht festgelegt.

value

Die Wertnutzlast aus der Aktivität.

Gibt zurück

Typ Beschreibung

Der Wert der Aktivität, der möglicherweise zusätzliche Benachrichtigungsdaten enthält.

wpx_comment

Die analysierte Word/PowerPoint/Excel-Kommentarentität, falls vorhanden.

Gibt zurück

Typ Beschreibung

Ein WpxComment-Objekt, wenn eine Kommentarentität gefunden und erfolgreich analysiert wurde, andernfalls None.

activity

Das zugrunde liegende Activity-Objekt.