AgentNotificationActivity 类

包含类型化通知实体的活动对象的包装器。

此类提供对从活动实体集合中提取的类型化通知实体的便捷访问。 它在构造时自动分析和验证电子邮件通知、Word/PowerPoint/Excel 注释和生命周期事件。

构造函数

AgentNotificationActivity()

参数

名称 说明
activity
必需

要包装的 Activity 对象。 不得为 None。

示例


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

方法

__init__
__new__
as_model

将活动值分析为自定义模型类型。

此方法提供了一种通用方法，用于验证和分析活动的值有效负载，并将其分析为任何 Pydantic 模型类型。 对于类型化属性不支持的自定义通知类型非常有用。

__init__ 

__init__(activity: Activity)

参数

名称 说明
activity
必需
Activity

__new__ 

__new__(**kwargs)

as_model

将活动值分析为自定义模型类型。

此方法提供了一种通用方法，用于验证和分析活动的值有效负载，并将其分析为任何 Pydantic 模型类型。 对于类型化属性不支持的自定义通知类型非常有用。

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

参数

名称 说明
model
必需
Type[<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel>]

一个 Pydantic 模型类，用于验证并分析活动值。

返回

类型 说明
<xref:microsoft_agents_a365.notifications.models.agent_notification_activity.TModel> | None

如果验证成功，则为指定模型类型的实例，否则为 None。

示例


   from pydantic import BaseModel

   class CustomNotification(BaseModel):
       custom_field: str

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

属性

channel

活动的channel_id中的通道标识符。

返回

类型 说明

通道名称（例如，“agents”、“msteams”）或 None（如果不可用）。

email

分析的电子邮件引用实体（如果存在）。

返回

类型 说明

如果找到并成功分析电子邮件通知实体，则为 EmailReference 对象，否则为 None。

notification_type

检测到的通知类型。

返回

类型 说明

指示通知类型（EMAIL_NOTIFICATION、WPX_COMMENT或AGENT_LIFECYCLE）的 NotificationTypes 枚举值;如果无法确定通知类型，则为 None。

sub_channel

活动channel_id中的子通道标识符。

返回

类型 说明

子通道名称（例如，“email”、“word”）或 None（如果不可用）。

type

活动类型。

返回

类型 说明

活动的类型（例如，“message”、“event”）或 None（如果未设置）。

value

活动中的值有效负载。

返回

类型 说明

活动的值，可能包含其他通知数据。

wpx_comment

分析的 Word/PowerPoint/Excel 注释实体（如果存在）。

返回

类型 说明

如果找到并成功分析注释实体，则为 WpxComment 对象，否则为 None。

activity

基础活动对象。