AgentNotificationActivity Klas
Wrapper rond een activiteitsobject met getypte meldingsentiteiten.
Deze klasse biedt handige toegang tot getypte meldingsentiteiten die zijn geëxtraheerd uit de verzameling entiteiten van een activiteit. Het parseert en valideert automatisch e-mailmeldingen, Word/PowerPoint/Excel-opmerkingen en levenscyclus-gebeurtenissen tijdens de bouw.
Constructor
AgentNotificationActivity()Parameters
| Name | Description |
|---|---|
|
activity
Vereist
|
Het activiteitsobject dat moet worden verpakt. Mag geen zijn. |
Voorbeelden
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}")
Methoden
| __init__ | |
| __new__ | |
| as_model |
Parseert de activiteitswaarde als een aangepast modeltype. Deze methode biedt een algemene manier om de nettolading van de waarde van de activiteit te valideren en te parseren in een Pydantic-modeltype. Handig voor aangepaste meldingstypen die niet rechtstreeks worden ondersteund door de getypte eigenschappen. |
__init__
__new__
__new__(**kwargs)as_model
Parseert de activiteitswaarde als een aangepast modeltype.
Deze methode biedt een algemene manier om de nettolading van de waarde van de activiteit te valideren en te parseren in een Pydantic-modeltype. Handig voor aangepaste meldingstypen die niet rechtstreeks worden ondersteund door de getypte eigenschappen.
as_model(model: Type[TModel]) -> TModel | NoneParameters
| Name | Description |
|---|---|
|
model
Vereist
|
Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]
Een Pydantic-modelklasse om de activiteitswaarde te valideren en te parseren. |
Retouren
| Type | Description |
|---|---|
|
<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel> | None
|
Een exemplaar van het opgegeven modeltype als de validatie slaagt, anders geen. |
Voorbeelden
from pydantic import BaseModel
class CustomNotification(BaseModel):
custom_field: str
notification = AgentNotificationActivity(activity)
custom = notification.as_model(CustomNotification)
if custom:
print(custom.custom_field)
Kenmerken
channel
De kanaal-id van de channel_id van de activiteit.
Retouren
| Type | Description |
|---|---|
|
De kanaalnaam (bijvoorbeeld 'agents', 'msteams') of Geen indien niet beschikbaar. |
De geparseerde e-mailreferentieentiteit, indien aanwezig.
Retouren
| Type | Description |
|---|---|
|
Een EmailReference-object als er een entiteit voor e-mailmeldingen is gevonden en geparseerd, anders geen. |
notification_type
Het gedetecteerde meldingstype.
Retouren
| Type | Description |
|---|---|
|
De enumwaarde NotificationTypes die het type melding aangeeft (EMAIL_NOTIFICATION, WPX_COMMENT of AGENT_LIFECYCLE) of Geen als het meldingstype niet kan worden bepaald. |
sub_channel
De subkanaal-id van de channel_id van de activiteit.
Retouren
| Type | Description |
|---|---|
|
De naam van de subkanaal (bijvoorbeeld 'e-mail', 'woord') of Geen indien niet beschikbaar. |
type
Het activiteitstype.
Retouren
| Type | Description |
|---|---|
|
Het type activiteit (bijvoorbeeld 'bericht', 'gebeurtenis') of Geen als dit niet is ingesteld. |
value
De nettolading van de waarde van de activiteit.
Retouren
| Type | Description |
|---|---|
|
De waarde van de activiteit, die mogelijk aanvullende meldingsgegevens bevat. |
wpx_comment
De geparseerde word-/PowerPoint-/Excel-opmerkingsentiteit, indien aanwezig.
Retouren
| Type | Description |
|---|---|
|
Een WpxComment-object als er een opmerkingsentiteit is gevonden en geparseerd, anders geen. |
activity
Het onderliggende activiteitsobject.