AgentNotificationActivity クラス

型指定された通知エンティティを持つ Activity オブジェクトのラッパー。

このクラスは、Activity のエンティティコレクションから抽出された型指定された通知エンティティに簡単にアクセスできます。電子メール通知、Word/PowerPoint/Excel のコメント、構築時のライフサイクルイベントを自動的に解析して検証します。

コンストラクター

AgentNotificationActivity()

パラメーター

名前	説明
activity 必須	ラップする Activity オブジェクト。 None にすることはできません。

例

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

email = 電子メールの場合 notification.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

アクティビティ値をカスタムモデル型として解析します。

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。

例

''<<>>'<<python 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

基になる Activity オブジェクト。