Activity クラス

リファレンス

定義

名前空間:: Microsoft.Bot.Schema

アセンブリ:: Microsoft.Bot.Schema.dll

パッケージ:: Microsoft.Bot.Schema v4.22.7

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

アクティビティは、Bot Framework 3.0 プロトコルの基本的な通信の種類です。

public class Activity : Microsoft.Bot.Schema.ICommandActivity, Microsoft.Bot.Schema.ICommandResultActivity, Microsoft.Bot.Schema.IContactRelationUpdateActivity, Microsoft.Bot.Schema.IConversationUpdateActivity, Microsoft.Bot.Schema.IEndOfConversationActivity, Microsoft.Bot.Schema.IEventActivity, Microsoft.Bot.Schema.IHandoffActivity, Microsoft.Bot.Schema.IInstallationUpdateActivity, Microsoft.Bot.Schema.IInvokeActivity, Microsoft.Bot.Schema.IMessageDeleteActivity, Microsoft.Bot.Schema.IMessageReactionActivity, Microsoft.Bot.Schema.IMessageUpdateActivity, Microsoft.Bot.Schema.ISuggestionActivity, Microsoft.Bot.Schema.ITraceActivity, Microsoft.Bot.Schema.ITypingActivity

type Activity = class
    interface IActivity
    interface IConversationUpdateActivity
    interface IContactRelationUpdateActivity
    interface IInstallationUpdateActivity
    interface IMessageActivity
    interface IMessageUpdateActivity
    interface IMessageDeleteActivity
    interface IMessageReactionActivity
    interface ISuggestionActivity
    interface ITypingActivity
    interface IEndOfConversationActivity
    interface IEventActivity
    interface IInvokeActivity
    interface ITraceActivity
    interface IHandoffActivity
    interface ICommandActivity
    interface ICommandResultActivity

Public Class Activity
Implements ICommandActivity, ICommandResultActivity, IContactRelationUpdateActivity, IConversationUpdateActivity, IEndOfConversationActivity, IEventActivity, IHandoffActivity, IInstallationUpdateActivity, IInvokeActivity, IMessageDeleteActivity, IMessageReactionActivity, IMessageUpdateActivity, ISuggestionActivity, ITraceActivity, ITypingActivity

継承: Object
Activity

実装: IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity

注釈

Activity クラスには、個々のより具体的なアクティビティに含めることができるすべてのプロパティが含まれます。スーパーセット型です。

コンストラクター

Activity()

Activity クラスの新しいインスタンスを初期化します。

Activity(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, ChannelAccount, ConversationAccount, ChannelAccount, String, String, IList<ChannelAccount>, IList<ChannelAccount>, IList<MessageReaction>, IList<MessageReaction>, String, Nullable<Boolean>, String, String, String, String, String, SuggestedActions, IList<Attachment>, IList<Entity>, Object, String, String, String, String, Object, String, ConversationReference, String, Nullable<DateTimeOffset>, String, String, IList<String>, IList<TextHighlight>, SemanticAction, String)

Activity クラスの新しいインスタンスを初期化します。

フィールド

ContentType

Activity メディアの種類のリソースを識別する HTTP Content-Type エンティティヘッダー。

プロパティ

Action	contactRelationUpdate の受信者が送信者の連絡先リストに追加されたか、送信者の連絡先リストから削除されたかを示す文字列を取得または設定します。
AttachmentLayout	複数の添付ファイルのレイアウトヒントを取得または設定します。既定値: リスト。指定できる値は、AttachmentLayoutTypesによって定義されます。
Attachments	アクティビティの添付ファイルを取得または設定します。
CallerId	ボットの呼び出し元を識別する IRI を含む文字列を取得または設定します。このフィールドはネットワーク経由で送信されるのではなく、呼び出し元の ID (トークンなど) をアサートする暗号で検証可能なデータに基づいてボットとクライアントによって設定されます。
ChannelData	チャネル固有のコンテンツを取得または設定します。
ChannelId	チャネルを一意に識別する ID を取得または設定します。チャネルによって設定されます。
Code	会話が終了した理由を示す endOfConversation アクティビティのコードを取得または設定します。使用可能な値は、EndOfConversationCodesで定義されます。
Conversation	アクティビティが属する会話を取得または設定します。
DeliveryMode	アクティビティの受信者の代替配信パスに通知する配信ヒントを取得または設定します。既定の配信モードは "default" です。使用可能な値は、DeliveryModesで定義されます。
Entities	メッセージに記載されたエンティティを取得または設定します。
Expiration	アクティビティが "期限切れ" と見なされ、受信者に表示されない時刻を取得または設定します。
From	メッセージの送信者を取得または設定します。
HistoryDisclosed	チャネルの以前の履歴が公開されているかどうかを示す値を取得または設定します。
Id	チャネルのアクティビティを一意に識別する ID を取得または設定します。
Importance	アクティビティの重要度を取得または設定します。使用可能な値は、ActivityImportanceで定義されます。
InputHint	メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、予期しているか、無視しているかを示す文字列を取得または設定します (InputHintsを参照してください。
Label	アクティビティのわかりやすいラベルを取得または設定します。
ListenFor	音声および言語プリミングシステムがリッスンする語句と参照の一覧を取得または設定します。
Locale	テキストフィールドの内容の BCP-47 ロケール名を取得または設定します。
LocalTimestamp	ISO-8601 形式で表された、メッセージが送信された日時をローカル時刻で取得または設定します。たとえば、2016-09-23T13:07:49.4714686-07:00 などです。
LocalTimezone	メッセージのローカル時刻を定義するために使用するタイムゾーンの名前を IANA タイムゾーンデータベース形式で表す値を取得または設定します。たとえば、アメリカ/Los_Angelesです。
MembersAdded	会話に追加されたメンバーのコレクションを取得または設定します。
MembersRemoved	会話から削除されたメンバーのコレクションを取得または設定します。
Name	呼び出しアクティビティまたはイベントアクティビティに関連付けられている操作の名前を取得または設定します。
Properties	Activity 型で定義されていないが、シリアル化された REST JSON オブジェクトに表示される可能性があるプロパティを取得または設定します。
ReactionsAdded	会話に追加されたリアクションのコレクションを取得または設定します。
ReactionsRemoved	会話から削除されたリアクションのコレクションを取得または設定します。
Recipient	メッセージの受信者を取得または設定します。
RelatesTo	別の会話またはアクティビティへの ConversationReference を取得または設定します。
ReplyToId	このメッセージが応答であるメッセージの ID を取得または設定します。
SemanticAction	この要求に付随するオプションのプログラムによるアクションを取得または設定します。
ServiceUrl	チャネルのサービスエンドポイントを指定する URL を取得または設定します。チャネルによって設定されます。
Speak	読み上げるテキストを取得または設定します。
SuggestedActions	アクティビティに対して推奨されるアクションを取得または設定します。
Summary	チャネルでカードをレンダリングできない場合に表示するテキストを取得または設定します。
Text	メッセージのテキストコンテンツを取得または設定します。
TextFormat	テキストフィールドの形式を取得または設定します。既定値: markdown。指定できる値は、TextFormatTypesによって定義されます。
TextHighlights	アクティビティに ReplyToId 値が含まれている場合に強調表示するテキストフラグメントのコレクションを取得または設定します。
Timestamp	ISO-8601 形式で表された、メッセージが送信された日時を UTC で取得または設定します。
TopicName	会話の更新されたトピック名を取得または設定します。
Type	アクティビティの種類を取得または設定します。使用できる値は、'message'、'contactRelationUpdate'、'conversationUpdate'、'typing'、'endOfConversation'、'event'、'invoke'、'deleteUserData'、'messageUpdate'、'messageDelete'、'installationUpdate'、'messageReaction'、'suggestion'、'trace'、'handoff' です。
Value	アクティビティに関連付けられている値を取得または設定します。
ValueType	アクティビティの value オブジェクトの型を取得または設定します。

メソッド

ApplyConversationReference(ConversationReference, Boolean)	既存の ConversationReferenceからの配信情報でこのアクティビティを更新します。
AsCommandActivity()	このアクティビティを ICommandActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsCommandResultActivity()	このアクティビティを ICommandResultActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsContactRelationUpdateActivity()	このアクティビティを IContactRelationUpdateActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsConversationUpdateActivity()	このアクティビティを IConversationUpdateActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsEndOfConversationActivity()	このアクティビティを IEndOfConversationActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsEventActivity()	このアクティビティを IEventActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsHandoffActivity()	このアクティビティを IHandoffActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsInstallationUpdateActivity()	このアクティビティを IInstallationUpdateActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsInvokeActivity()	このアクティビティを IInvokeActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsMessageActivity()	このアクティビティを IMessageActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsMessageDeleteActivity()	このアクティビティを IMessageDeleteActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsMessageReactionActivity()	このアクティビティを IMessageReactionActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsMessageUpdateActivity()	このアクティビティを IMessageUpdateActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsSuggestionActivity()	このアクティビティを ISuggestionActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsTraceActivity()	このアクティビティを ITraceActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
AsTypingActivity()	このアクティビティを ITypingActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
CreateContactRelationUpdateActivity()	IContactRelationUpdateActivity オブジェクトとして Activity クラスのインスタンスを作成します。
CreateConversationUpdateActivity()	IConversationUpdateActivity オブジェクトとして Activity クラスのインスタンスを作成します。
CreateEndOfConversationActivity()	IEndOfConversationActivity オブジェクトとして Activity クラスのインスタンスを作成します。
CreateEventActivity()	IEventActivity オブジェクトとして Activity クラスのインスタンスを作成します。
CreateHandoffActivity()	IHandoffActivity オブジェクトとして Activity クラスのインスタンスを作成します。
CreateInvokeActivity()	IInvokeActivity オブジェクトとして Activity クラスのインスタンスを作成します。
CreateMessageActivity()	IMessageActivity オブジェクトとして Activity クラスのインスタンスを作成します。
CreateReply(String, String)	このアクティビティへの応答として新しいメッセージアクティビティを作成します。
CreateTrace(String, Object, String, String)	このアクティビティに基づいて新しいトレースアクティビティを作成します。
CreateTraceActivity(String, String, Object, String)	ITraceActivity オブジェクトとして Activity クラスのインスタンスを作成します。
CreateTypingActivity()	ITypingActivity オブジェクトとして Activity クラスのインスタンスを作成します。
GetChannelData<TypeT>()	このアクティビティのチャネルデータを厳密に型指定されたオブジェクトとして取得します。
GetConversationReference()	このアクティビティに基づいて ConversationReference を作成します。
GetMentions()	このアクティビティのエンティティからのメンションを解決します。
GetReplyConversationReference(ResourceResponse)	このアクティビティの会話情報と、アクティビティの送信からの ResourceResponse に基づいて ConversationReference を作成します。
HasContent()	このアクティビティにコンテンツがあるかどうかを示します。
IsActivity(String)	このアクティビティが指定されたアクティビティの種類であるかどうかを示します。
IsFromStreamingConnection()	アクティビティが Http/Https 接続またはストリーミング経由で送信されたかどうかを確認します。これは、ServiceUrl プロパティを参照して判断できます。(1) http/https 経由でメッセージを送信するすべてのチャネルがストリーミングされていない (2) ストリーミング経由でメッセージを送信するチャネルには、http/https で始まらない ServiceUrl があります。
TryGetChannelData<TypeT>(TypeT)	このアクティビティのチャネルデータを厳密に型指定されたオブジェクトとして取得します。戻り値は、操作が成功したかどうかを表します。

拡張メソッド

TeamsGetChannelId(IActivity)	現在のアクティビティからチームのチャネル ID を取得します。
TeamsGetMeetingInfo(IActivity)	現在のアクティビティから TeamsMeetingInfo オブジェクトを取得します。
TeamsGetSelectedChannelId(IActivity)	現在のアクティビティからチームの選択したチャネル ID を取得します。
TeamsGetTeamInfo(IActivity)	現在のアクティビティから TeamsInfo オブジェクトを取得します。
TeamsGetTeamOnBehalfOf(IActivity)	現在のアクティビティから Teams OnBehalfOf リストを取得します。
TeamsNotifyUser(IActivity, Boolean, String)	Teams 内で通知を生成するように現在のアクティビティを構成します。
TeamsNotifyUser(IActivity)	Teams 内で通知を生成するように現在のアクティビティを構成します。
MentionsId(IMessageActivity, String)	Text プロパティに ID のメンションはありますか。
MentionsRecipient(IMessageActivity)	Text プロパティに Recipient.Id に関する説明はありますか。
RemoveMentionText(IMessageActivity, String)	指定した ID のメンションテキストを Activity.Text プロパティから削除します。たとえば、Hi Bot @echoBot メッセージを指定すると、"@echoBot" が削除され、"Hi Bot" が残ります。
RemoveRecipientMention(IMessageActivity)	Text プロパティから受信者のメンションテキストを削除します。この関数はアクティビティのテキストを変更するため、注意して使用してください。
GetLocale(IActivity)	アクティビティのロケールを取得します。
SetLocale(IActivity, String)	アクティビティのロケールを設定します。

適用対象

次の方法で共有