Choice interface

パッケージ:: botbuilder-dialogs

選択肢をユーザーにレンダリングしたり、ユーザーが選択した内容を認識したりするために使用できる選択肢のインスタンス。

注釈

値は、アクションが指定されていない限り、ユーザーにレンダリングされます。この場合、アクションがユーザーにレンダリングされます。

認識時には、value は常に findChoices() と recognizeChoices()によって返されます。既定では、ユーザーの発話は、選択で指定されたすべての文字列と比較されます。 value 構造を使用して、認識中に action.title や FindChoicesOptions を使用して無効にできます。

const choice = {
    value: 'red',
    action: {
        type: 'imBack',
        title: 'The Red Pill',
        value: 'red pill'
    },
    synonyms: ['crimson', 'scarlet', 'ruby', 'cherry']
};

プロパティ

action	(省略可能) 選択肢を推奨アクションとしてレンダリングするときに使用するアクション。この、`type`、`title`、および `value` フィールドを含む完全なアクションである必要があります。指定しない場合は、フィールドの値の選択肢に基づいて `imBack` アクション生成。
synonyms	(省略可能) 値のとアクションフィールドに加えて認識するシノニムのリスト。
value	`findChoices()`によって認識されたときに返される値。また、アクションが指定されていない場合は、ユーザーに選択肢を表示するためにも使用されます。

プロパティの詳細

action

(省略可能) 選択肢を推奨アクションとしてレンダリングするときに使用するアクション。この、type、title、および value フィールドを含む完全なアクションである必要があります。指定しない場合は、フィールドの値の選択肢に基づいて imBack アクション生成。

action?: CardAction

プロパティ値

CardAction

synonyms

(省略可能) 値のとアクションフィールドに加えて認識するシノニムのリスト。

synonyms?: string[]

プロパティ値

string[]

value

findChoices()によって認識されたときに返される値。また、アクションが指定されていない場合は、ユーザーに選択肢を表示するためにも使用されます。

value: string

プロパティ値

string