AgentNotificationActivity Clase

Contenedor alrededor de un objeto Activity con entidades de notificación con tipo.

Esta clase proporciona un acceso práctico a las entidades de notificación con tipo extraídas de la colección de entidades de una actividad. Analiza y valida automáticamente las notificaciones por correo electrónico, los comentarios de Word/PowerPoint/Excel y los eventos de ciclo de vida en tiempo de construcción.

Constructor

AgentNotificationActivity()

Parámetros

Nombre Description
activity
Requerido

Objeto Activity que se va a ajustar. No debe ser Ninguno.

Ejemplos

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

email = notification.email si el correo electrónico:

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

''<<>>'<<

Métodos

__init__
__new__
as_model

Analice el valor de la actividad como un tipo de modelo personalizado.

Este método proporciona una manera genérica de validar y analizar la carga útil del valor de la actividad en cualquier tipo de modelo Pydantic. Resulta útil para los tipos de notificación personalizados que no son compatibles directamente con las propiedades tipadas.

__init__

__init__(activity: Activity)

Parámetros

Nombre Description
activity
Requerido

__new__

__new__(**kwargs)

as_model

Analice el valor de la actividad como un tipo de modelo personalizado.

Este método proporciona una manera genérica de validar y analizar la carga útil del valor de la actividad en cualquier tipo de modelo Pydantic. Resulta útil para los tipos de notificación personalizados que no son compatibles directamente con las propiedades tipadas.

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

Parámetros

Nombre Description
model
Requerido
Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]

Clase de modelo Pydantic para validar y analizar el valor de la actividad.

Devoluciones

Tipo Description
<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel> | None

Instancia del tipo de modelo especificado si la validación se realiza correctamente; de lo contrario, None.

Ejemplos

'''<<>><<python from pydantic import BaseModel

clase CustomNotification(BaseModel): custom_field: str

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

print(custom.custom_field)

''<<>>'<<

Atributos

channel

Identificador de canal del channel_id de la actividad.

Devoluciones

Tipo Description

Nombre del canal (por ejemplo, "agentes", "msteams") o Ninguno si no está disponible.

email

Entidad de referencia de correo electrónico analizado, si está presente.

Devoluciones

Tipo Description

Objeto EmailReference si se encontró una entidad de notificación por correo electrónico y se anificó correctamente; de lo contrario, None.

notification_type

Tipo de notificación detectado.

Devoluciones

Tipo Description

Valor de enumeración NotificationTypes que indica el tipo de notificación (EMAIL_NOTIFICATION, WPX_COMMENT o AGENT_LIFECYCLE) o None si no se pudo determinar el tipo de notificación.

sub_channel

Identificador de subcanal del channel_id de la actividad.

Devoluciones

Tipo Description

Nombre de subcanal (por ejemplo, "email", "word") o None si no está disponible.

type

Tipo de actividad.

Devoluciones

Tipo Description

Tipo de la actividad (por ejemplo, "message", "event") o None si no se establece.

value

Carga útil del valor de la actividad.

Devoluciones

Tipo Description

El valor de la actividad, que puede contener datos de notificación adicionales.

wpx_comment

La entidad de comentario de Word/PowerPoint/Excel analizada, si está presente.

Devoluciones

Tipo Description

Objeto WpxComment si se encontró una entidad de comentario y se anó correctamente; de lo contrario, None.

activity

Objeto Activity subyacente.