次の方法で共有


ActivityHandler クラス

定義

さらにサブクラス化することを目的とした、IBot インターフェイスの実装。

public class ActivityHandler : Microsoft.Bot.Builder.IBot
type ActivityHandler = class
    interface IBot
Public Class ActivityHandler
Implements IBot
継承
ActivityHandler
派生
実装

注釈

このクラスから派生して、特定のアクティビティの種類を処理するコードをプラグインします。 派生クラスから基底クラスの実装を呼び出すことによって、Activity オブジェクトの前処理と後処理を追加できます。

コンストラクター

ActivityHandler()

さらにサブクラス化することを目的とした、IBot インターフェイスの実装。

メソッド

CreateInvokeResponse(Object)

渡されたパラメーターに対して本文を初期化し、状態が OK と等しい InvokeResponse ファクトリ。

OnAdaptiveCardInvokeAsync(ITurnContext<IInvokeActivity>, AdaptiveCardInvokeValue, CancellationToken)

ボットがアダプティブ カード アクションの実行を送信されたときに呼び出されます。

OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken)

OnTurnAsync(ITurnContext, CancellationToken) の基本動作が使用されたときにコマンド アクティビティを受信したときに呼び出されます。 コマンドはアクションを実行するための要求であり、受信者は通常、1 つ以上の commandResult アクティビティで応答します。 受信側は、サポートされていないコマンド アクティビティを明示的に拒否することも期待されます。

OnCommandResultActivityAsync(ITurnContext<ICommandResultActivity>, CancellationToken)

OnTurnAsync(ITurnContext, CancellationToken) の基本動作が使用されたときに CommandResult アクティビティを受信したときに呼び出されます。 CommandResult アクティビティは、コマンド実行の結果を伝えるために使用できます。

OnConversationUpdateActivityAsync(ITurnContext<IConversationUpdateActivity>, CancellationToken)

OnTurnAsync(ITurnContext, CancellationToken) の基本動作が使用されるときに、チャネルから会話更新アクティビティを受信したときに呼び出されます。 会話の更新アクティビティは、会話に追加または会話から削除されるユーザーに応答する場合に便利です。 たとえば、ボットは、ユーザーにあいさつすることで追加されるユーザーに応答できます。 既定では、このメソッドは、ユーザーが追加された場合は OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) を呼び出し、ユーザーが削除された場合は OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) します。 このメソッドは、ボット自体以外のメンバーに関する更新にのみ応答するようにメンバー ID をチェックします。

OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken)

これを派生クラスでオーバーライドして、会話ロジックなどの EndOfConversation アクティビティに固有のロジックを提供します。

OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken)

OnTurnAsync(ITurnContext, CancellationToken) の基本動作が使用されるときに、コネクタからイベント アクティビティを受信したときに呼び出されます。 イベント アクティビティは、さまざまなことを伝えるために使用できます。 既定では、このメソッドはアクティビティの名前が tokens/response の場合は OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) を呼び出すか、それ以外の場合は OnEventAsync(ITurnContext<IEventActivity>, CancellationToken) します。 tokens/response イベントは、OAuthCardによってトリガーできます。

OnEventAsync(ITurnContext<IEventActivity>, CancellationToken)

OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) の基本動作が使用されたときに、tokens/response 以外のイベントを受信したときに呼び出されます。 ボットが他のイベントを処理することを意図している場合は、必要に応じてこのメソッドをオーバーライドできます。 既定では、このメソッドは何も行いません。

OnInstallationUpdateActivityAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

派生クラスでこれをオーバーライドして、InstallationUpdate アクティビティに固有のロジックを提供します。

OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

'action' が 'add' に設定された InstallationUpdate アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。

OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

'action' が 'remove' に設定された InstallationUpdate アクティビティに固有のロジックを提供するには、派生クラスでこれをオーバーライドします。

OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken)

OnTurnAsync(ITurnContext, CancellationToken) の基本動作が使用されている場合に、コネクタから呼び出しアクティビティを受信したときに呼び出されます。 呼び出しアクティビティは、さまざまなことを伝えるために使用できます。 既定では、このメソッドは、アクティビティの名前が signin/verifyState または signin/tokenExchange場合に OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken) を呼び出します。 signin/verifyState または signin/tokenExchange 呼び出しは、OAuthCardによってトリガーできます。

OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)

ボットのウェルカム ロジックなど、ボット以外のメンバーが会話に参加する場合のロジックを提供するには、派生クラスでこれをオーバーライドします。

OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)

ボットのさよならロジックなど、ボット以外のメンバーが会話を離れたときのロジックを提供するには、派生クラスでこれをオーバーライドします。

OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken)

これを派生クラスでオーバーライドして、会話ロジックなどの Message アクティビティに固有のロジックを提供します。

OnMessageDeleteActivityAsync(ITurnContext<IMessageDeleteActivity>, CancellationToken)

これを派生クラスでオーバーライドして、会話ロジックなどの MessageDelete アクティビティに固有のロジックを提供します。

OnMessageReactionActivityAsync(ITurnContext<IMessageReactionActivity>, CancellationToken)

OnTurnAsync(ITurnContext, CancellationToken) の基本動作が使用されるときに、コネクタからイベント アクティビティを受信したときに呼び出されます。 メッセージの反応は、以前に送信されたアクティビティに "いいね" や "sad" などの (多くの場合絵文字) を追加するユーザーに対応します。 メッセージの反応は、少数のチャネルでのみサポートされます。 メッセージの反応が対応するアクティビティは、replyToId プロパティに示されます。 このプロパティの値は、送信呼び出しからの応答としてボットに返された、以前に送信されたアクティビティのアクティビティ ID です。

OnMessageUpdateActivityAsync(ITurnContext<IMessageUpdateActivity>, CancellationToken)

これを派生クラスでオーバーライドして、会話ロジックなどの MessageUpdate アクティビティに固有のロジックを提供します。

OnReactionsAddedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)

前のアクティビティへの反応が会話に追加されるタイミングのロジックを提供するには、派生クラスでこれをオーバーライドします。

OnReactionsRemovedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)

派生クラスでこれをオーバーライドして、前のアクティビティへの反応が会話から削除されるタイミングのロジックを提供します。

OnSearchInvokeAsync(ITurnContext<IInvokeActivity>, SearchInvokeValue, CancellationToken)

"application/search" という名前の "invoke" アクティビティがボットに送信されたときに呼び出されます。

OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken)

OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) の基本動作が使用されるときに、signin/verifyState または signin/tokenExchange イベントを受信したときに呼び出されます。 OAuthPromptを使用している場合は、このメソッドをオーバーライドして、この Activity を現在のダイアログに転送します。 既定では、このメソッドは何も行いません。

OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken)

OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) の基本動作が使用されるときに、tokens/response イベントを受信したときに呼び出されます。 OAuthPromptを使用している場合は、このメソッドをオーバーライドして、この Activity を現在のダイアログに転送します。 既定では、このメソッドは何も行いません。

OnTurnAsync(ITurnContext, CancellationToken)

受信 Activityを処理するために、実行時にアダプター (BotFrameworkAdapterなど) によって呼び出されます。

OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken)

これを派生クラスでオーバーライドして、会話ロジックなどの Typing アクティビティに固有のロジックを提供します。

OnUnrecognizedActivityTypeAsync(ITurnContext, CancellationToken)

OnTurnAsync(ITurnContext, CancellationToken) の基本動作が使用されたときに、メッセージ、会話の更新、またはイベント以外のアクティビティを受信したときに呼び出されます。 オーバーライドされた場合、これは、ContactRelationUpdateEndOfConversationなどの他のアクティビティの種類に応答する可能性があります。 既定では、このメソッドは何も行いません。

適用対象