ActivityHandler クラス

public ActivityHandler()

protected InvokeResponse createInvokeResponse(Object body)

指定した本文で成功 InvokeResponse を作成します。

パラメーター:

戻り値:

protected CompletableFuture onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)

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

パラメーター:

戻り値:

protected CompletableFuture onCommandActivity(TurnContext turnContext)

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

パラメーター:

戻り値:

protected CompletableFuture onCommandResultActivity(TurnContext turnContext)

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

パラメーター:

戻り値:

protected CompletableFuture onConversationUpdateActivity(TurnContext turnContext)

onTurn(TurnContext turnContext) の基本動作が使用されるときに、チャネルから会話更新アクティビティを受信したときに呼び出されます。

会話の更新アクティビティは、会話に追加または会話から削除されるユーザーに応答する場合に便利です。

たとえば、ボットは、ユーザーにあいさつすることで追加されるユーザーに応答できます。 既定では、このメソッドは、ユーザーが追加された場合は onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext) を呼び出し、ユーザーが削除された場合は onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext) します。 このメソッドは、ボット自体以外のメンバーに関する更新にのみ応答するようにメンバー ID をチェックします。

パラメーター:

戻り値:

protected CompletableFuture onEndOfConversationActivity(TurnContext turnContext)

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

パラメーター:

戻り値:

protected CompletableFuture onEvent(TurnContext turnContext)

onEventActivity(TurnContext turnContext) の基本動作が使用されるときに、トークン/応答以外のイベントを受信したときに呼び出されます。

ボットが他のイベントを処理することを意図している場合は、必要に応じてこのメソッドをオーバーライドできます。

既定では、このメソッドは何も行いません。

onEventActivity(TurnContext turnContext) メソッドは、'tokens/response' 以外の Activity#getName() を持つイベントを受け取ると、このメソッドを呼び出します。

パラメーター:

戻り値:

protected CompletableFuture onEventActivity(TurnContext turnContext)

onTurn(TurnContext turnContext) の基本動作が使用されるときに、コネクタからイベント アクティビティを受信したときに呼び出されます。

イベント アクティビティは、さまざまなことを伝えるために使用できます。

既定では、このメソッドはアクティビティの名前が "tokens/response" の場合は onTokenResponseEvent(TurnContext turnContext) を呼び出すか、それ以外の場合は onEvent(TurnContext turnContext) 呼び出します。 "tokens/response" イベントは、com.microsoft.bot.schema.OAuthCardによってトリガーできます。

onTurn(TurnContext turnContext) メソッドは、イベント アクティビティを受信すると、このメソッドを呼び出します。

イベント Activity#getName が 'tokens/response' の場合は、onTokenResponseEvent(TurnContext turnContext) 呼び出し、それ以外の場合は onEvent(TurnContext turnContext)を呼び出します。

派生クラスで、このメソッドをオーバーライドして、すべてのイベント アクティビティに適用されるロジックを追加します。 基底クラス メソッドの呼び出しの前に、特定のイベント処理ロジックの前に適用するロジックを追加します。 基底クラス メソッドの呼び出しの後に、特定のイベント処理ロジックの後に適用するロジックを追加します。

イベント アクティビティは、クライアントまたはチャネルからボットにプログラム情報を伝達します。 イベント アクティビティの意味は、チャネルのスコープ内で意味のある Activity#getName プロパティによって定義されます。 "tokens/response" イベントは、com.microsoft.bot.schema.OAuthCard または OAuth プロンプトによってトリガーできます。

パラメーター:

戻り値:

protected CompletableFuture onInstallationUpdate(TurnContext turnContext)

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

パラメーター:

戻り値:

protected CompletableFuture onInstallationUpdateAdd(TurnContext turnContext)

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

パラメーター:

戻り値:

protected CompletableFuture onInstallationUpdateRemove(TurnContext turnContext)

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

パラメーター:

戻り値:

protected CompletableFuture onInvokeActivity(TurnContext turnContext)

onTurn の基本動作が使用されている場合に、コネクタから呼び出しアクティビティを受信したときに呼び出されます。

呼び出しアクティビティは、さまざまなことを伝えるために使用できます。 アクティビティの名前が 'signin/verifyState' または 'signin/tokenExchange' の場合、このメソッドは既定で onSignInInvokeAsync を呼び出します。

'signin/verifyState' または 'signin/tokenExchange' の呼び出しは、OAuthCard によってトリガーできます。

パラメーター:

戻り値:

protected CompletableFuture onMembersAdded(List membersAdded, TurnContext turnContext)

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

onConversationUpdateActivity(TurnContext turnContext) メソッドは、bo 以外の 1 人以上のユーザーが会話に参加していることを示す会話更新アクティビティを受け取ると、このメソッドを呼び出します。

パラメーター:

戻り値:

protected CompletableFuture onMembersRemoved(List membersRemoved, TurnContext turnContext)

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

onConversationUpdateActivity(TurnContext turnContext) メソッドは、ボット以外の 1 人以上のユーザーが会話から離れることを示す会話更新アクティビティを受け取ると、このメソッドを呼び出します。

パラメーター:

戻り値:

protected CompletableFuture onMessageActivity(TurnContext turnContext)

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

onTurn(TurnContext turnContext) メソッドは、メッセージ アクティビティを受信すると、このメソッドを呼び出します。

パラメーター:

戻り値:

protected CompletableFuture onMessageReactionActivity(TurnContext turnContext)

onTurn(TurnContext turnContext) の基本動作が使用されるときに、コネクタからイベント アクティビティを受信したときに呼び出されます。

メッセージの反応は、以前に送信されたアクティビティに "いいね" や "sad" などの (多くの場合絵文字) を追加するユーザーに対応します。 メッセージの反応は、少数のチャネルでのみサポートされます。

メッセージの反応が対応するアクティビティは、replyToId プロパティに示されます。 このプロパティの値は、送信呼び出しからの応答としてボットに返された、以前に送信されたアクティビティのアクティビティ ID です。

onTurn(TurnContext turnContext) メソッドは、メッセージの反応アクティビティを受け取ると、このメソッドを呼び出します。 メッセージの反応がメッセージに追加されたことを示す場合は、onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext)を呼び出します。 メッセージの反応がメッセージから削除されたことを示す場合は、onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext)を呼び出します。

派生クラスで、このメソッドをオーバーライドして、すべてのメッセージ反応アクティビティに適用されるロジックを追加します。 基本クラス メソッドの呼び出しの前に、リアクションがロジックを追加または削除する前に適用するロジックを追加します。 基本クラスの呼び出し後に、リアクションの追加または削除されたロジックの後に適用するロジックを追加します。

パラメーター:

戻り値:

protected CompletableFuture onReactionsAdded(List messageReactions, TurnContext turnContext)

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

メッセージの反応は、会話で以前に送信されたメッセージに "いいね" や "sad" などの文字 (多くの場合は絵文字) を追加するユーザーに対応します。 メッセージの反応は、少数のチャネルでのみサポートされます。 メッセージが反応しているアクティビティは、アクティビティの Activity#getReplyToId() プロパティによって識別されます。 このプロパティの値は、以前に送信されたアクティビティのアクティビティ ID です。 ボットがアクティビティを送信すると、チャネルによって ID が割り当てられます。ID は結果の com.microsoft.bot.schema.ResourceResponse#getId で使用できます。

パラメーター:

戻り値:

protected CompletableFuture onReactionsRemoved(List messageReactions, TurnContext turnContext)

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

メッセージの反応は、会話で以前に送信されたメッセージに "いいね" や "sad" などの文字 (多くの場合は絵文字) を追加するユーザーに対応します。 メッセージの反応は、少数のチャネルでのみサポートされます。 メッセージが反応しているアクティビティは、アクティビティの Activity#getReplyToId() プロパティによって識別されます。 このプロパティの値は、以前に送信されたアクティビティのアクティビティ ID です。 ボットがアクティビティを送信すると、チャネルによって ID が割り当てられます。ID は結果の com.microsoft.bot.schema.ResourceResponse#getId で使用できます。

パラメーター:

戻り値:

protected CompletableFuture onSignInInvoke(TurnContext turnContext)

onInvokeActivity の基本動作が使用されるときに、'signin/verifyState' または 'signin/tokenExchange' イベントを受信したときに呼び出されます。

OAuthPrompt を使用している場合は、このメソッドをオーバーライドして、このアクティビティを現在のダイアログに転送します。 既定では、このメソッドは何も行いません。

onInvokeActivity メソッドは、"tokens/response" という名前の Invoke を受け取ると、このメソッドを呼び出します。

ボットで OAuthPrompt を使用している場合は、受信アクティビティを現在のダイアログに転送します。

パラメーター:

戻り値:

protected CompletableFuture onTokenResponseEvent(TurnContext turnContext)

onEventActivity(TurnContext turnContext) の基本動作が使用されたときに "tokens/response" イベントを受信したときに呼び出されます。

OAuthPrompt を使用している場合は、このメソッドをオーバーライドして、この Activity を現在のダイアログに転送します。

既定では、このメソッドは何も行いません。

onEventActivity(TurnContext turnContext) メソッドは、'tokens/response' の Activity#getName() を持つイベントを受け取ると、このメソッドを呼び出します。

パラメーター:

戻り値:

public CompletableFuture onTurn(TurnContext turnContext)

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

このメソッドは、処理するアクティビティの型に基づいてこのクラス内の他のメソッドを呼び出します。これにより、派生クラスは、制御された方法で型固有のロジックを提供できます。

派生クラスで、このメソッドをオーバーライドして、すべてのアクティビティの種類に適用されるロジックを追加します。 基底クラス onTurn(TurnContext turnContext) メソッドの呼び出しの前に、型固有のロジックの前に適用するロジックを追加します。 基底クラス onTurn(TurnContext turnContext) メソッドの呼び出しの後に、型固有のロジックの後に適用するロジックを追加します。

パラメーター:

戻り値:

protected CompletableFuture onTypingActivity(TurnContext turnContext)

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

パラメーター:

戻り値:

protected CompletableFuture onUnrecognizedActivityType(TurnContext turnContext)

onTurn(TurnContext turnContext) の基本動作が使用されたときに、メッセージ、会話の更新、またはイベント以外のアクティビティを受信したときに呼び出されます。

オーバーライドされた場合、これは、com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE や com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATIONなどの他のアクティビティの種類に応答する可能性があります。

既定では、このメソッドは何も行いません。

onTurn(TurnContext turnContext) メソッドは、メッセージ、会話の更新、メッセージの反応、またはイベント アクティビティではないアクティビティを受信すると、このメソッドを呼び出します。

パラメーター:

戻り値: