ICancelActionOptions interface
cancelAction()を定義するときに渡されるオプション。
- Extends
プロパティ
| confirm |
指定した場合、ユーザーは、トリガーされたときにアクションを本当にキャンセルすることを確認するように求められます。 |
| intent |
(省略可能)に一致する |
| matches | (省略可能) アクションのトリガーに使用される意図。 正規表現または名前付き意図のいずれかを指定でき、複数の意図を指定できます。 名前付き意図が指定されると、Library.recognizer()を使用して、ライブラリ/ボットに割り当てられた認識エンジンを使用してアクションが照合されます。 一致するオプションが指定されていない場合、アクションは、onFindAction ハンドラーが指定されている場合にのみ照合できます。 |
| on |
(省略可能) アクションがトリガーされる必要があるかどうかを確認するためにチェックされるたびに呼び出されるカスタム ハンドラー。 ハンドラーには、受信したメッセージと検出された意図を含むコンテキスト オブジェクトが渡されます。 ハンドラーは、0.0 から 1.0 の信頼度スコアと、 |
| on |
(省略可能) アクションがトリガーされるたびに呼び出されるカスタム ハンドラー。 これにより、アクションの動作をカスタマイズできます。 たとえば、新しいダイアログが開始される前にダイアログ スタックをクリアし、新しいダイアログをスタックの末尾にプッシュするだけの既定の動作を変更できます。
これはウォーターフォールではないため、アクションの既定の動作を実行する場合は |
プロパティの詳細
confirmPrompt
指定した場合、ユーザーは、トリガーされたときにアクションを本当にキャンセルすることを確認するように求められます。
confirmPrompt?: TextOrMessageTypeプロパティ値
intentThreshold
(省略可能)に一致する
intentThreshold?: numberプロパティ値
number
matches
(省略可能) アクションのトリガーに使用される意図。 正規表現または名前付き意図のいずれかを指定でき、複数の意図を指定できます。 名前付き意図が指定されると、Library.recognizer()を使用して、ライブラリ/ボットに割り当てられた認識エンジンを使用してアクションが照合されます。 一致するオプションが指定されていない場合、アクションは、onFindAction ハンドラーが指定されている場合にのみ照合できます。
matches?: MatchTypeプロパティ値
onFindAction
(省略可能) アクションがトリガーされる必要があるかどうかを確認するためにチェックされるたびに呼び出されるカスタム ハンドラー。 ハンドラーには、受信したメッセージと検出された意図を含むコンテキスト オブジェクトが渡されます。 ハンドラーは、0.0 から 1.0 の信頼度スコアと、selectActionRoute 呼び出し中に渡す必要がある routeData を返す必要があります。
onFindAction?: (context: IFindActionRouteContext, callback: (err: Error, score: number, routeData?: IActionRouteData) => void) => voidプロパティ値
(context: IFindActionRouteContext, callback: (err: Error, score: number, routeData?: IActionRouteData) => void) => void
onSelectAction
(省略可能) アクションがトリガーされるたびに呼び出されるカスタム ハンドラー。 これにより、アクションの動作をカスタマイズできます。 たとえば、新しいダイアログが開始される前にダイアログ スタックをクリアし、新しいダイアログをスタックの末尾にプッシュするだけの既定の動作を変更できます。
これはウォーターフォールではないため、アクションの既定の動作を実行する場合は next() を呼び出す必要があることに注意してください。
onSelectAction?: (session: Session, args?: IActionRouteData, next?: Function) => voidプロパティ値
(session: Session, args?: IActionRouteData, next?: Function) => void