次の方法で共有

InputDialog class

  • リファレンス
パッケージ:
botbuilder-dialogs-adaptive

入力ダイアログを定義します。

Extends

Dialog

コンストラクター

InputDialog(string, Partial<Activity> | string)

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

プロパティ

allowInterruptions

割り込みポリシー。
alwaysPrompt

値があるかどうかに関係なく、入力で常にユーザーにプロンプトを表示するかどうかを示す値。
defaultValue

maxTurnCount を超えた場合の入力ダイアログの既定値。
defaultValueResponse

maxTurnCount に達し、既定値が使用されたときに送信するアクティビティ テンプレート。
disabled

true の場合は、このアクションを無効にする省略可能な式。
invalidPrompt

指定された値が無効かどうかに関係なく、ユーザーに送信するアクティビティ テンプレート。
maxTurnCount

ダイアログが終了するまでにユーザーにこの値を要求する最大回数。
OPTIONS_PROPERTY
prompt

ユーザーに送信するアクティビティ。
property

入力のバインド先となる値式。
TURN_COUNT_PROPERTY
unrecognizedPrompt

再試行プロンプトのアクティビティ テンプレート。
validations

入力を検証するために実行する式。
value

入力プロンプトを初期化するために使用できる値式。
VALUE_PROPERTY

継承されたプロパティ

EndOfTurn

既定のターン終了の結果を取得します。
id
telemetryClient

メソッド

beginDialog(DialogContext, any)

ダイアログ が開始され、ダイアログ スタックにプッシュされたときに呼び出されます。
continueDialog(DialogContext)

ダイアログ が継続 場合に呼び出されます。このダイアログはアクティブなダイアログで、ユーザーは新しいアクティビティで応答します。
getConverter(Object)
resumeDialog(DialogContext, DialogReason, any)

子 ダイアログ がターンを完了し、このダイアログに制御を返すと呼び出されます。

継承されたメソッド

configure(Record<string, unknown>)

オブジェクトを構成するための Fluent メソッド。
endDialog(TurnContext, DialogInstance, DialogReason)

派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。
getVersion()

再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。
onDialogEvent(DialogContext, DialogEvent)

現在のダイアログまたは現在のダイアログが開始したダイアログによって、DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。
repromptDialog(TurnContext, DialogInstance)

派生クラスでオーバーライドされると、ユーザーに入力を要求します。

コンストラクターの詳細

InputDialog(string, Partial<Activity> | string)

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

new InputDialog(property?: string, prompt?: Partial<Activity> | string)

パラメーター

property

string

随意。 入力のバインド先となる値式。

prompt

Partial<Activity> | string

随意。 ユーザーに送信する アクティビティ。文字列が指定されている場合、ActivityTemplateがインスタンス化されます。

プロパティの詳細

allowInterruptions

割り込みポリシー。

allowInterruptions: BoolExpression

プロパティ値

BoolExpression

alwaysPrompt

値があるかどうかに関係なく、入力で常にユーザーにプロンプトを表示するかどうかを示す値。

alwaysPrompt: BoolExpression

プロパティ値

BoolExpression

defaultValue

maxTurnCount を超えた場合の入力ダイアログの既定値。

defaultValue?: ValueExpression

プロパティ値

ValueExpression

defaultValueResponse

maxTurnCount に達し、既定値が使用されたときに送信するアクティビティ テンプレート。

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

プロパティ値

TemplateInterface<Partial<Activity>, DialogStateManager>

disabled

true の場合は、このアクションを無効にする省略可能な式。

disabled?: BoolExpression

プロパティ値

BoolExpression

invalidPrompt

指定された値が無効かどうかに関係なく、ユーザーに送信するアクティビティ テンプレート。

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

プロパティ値

TemplateInterface<Partial<Activity>, DialogStateManager>

maxTurnCount

ダイアログが終了するまでにユーザーにこの値を要求する最大回数。

maxTurnCount?: IntExpression

プロパティ値

IntExpression

OPTIONS_PROPERTY 

static OPTIONS_PROPERTY: string

プロパティ値

string

prompt

ユーザーに送信するアクティビティ。

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

プロパティ値

TemplateInterface<Partial<Activity>, DialogStateManager>

property

入力のバインド先となる値式。

property: StringExpression

プロパティ値

StringExpression

TURN_COUNT_PROPERTY 

static TURN_COUNT_PROPERTY: string

プロパティ値

string

unrecognizedPrompt

再試行プロンプトのアクティビティ テンプレート。

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

プロパティ値

TemplateInterface<Partial<Activity>, DialogStateManager>

validations

入力を検証するために実行する式。

validations: string[]

プロパティ値

string[]

value

入力プロンプトを初期化するために使用できる値式。

value: ValueExpression

プロパティ値

ValueExpression

VALUE_PROPERTY 

static VALUE_PROPERTY: string

プロパティ値

string

継承されたプロパティの詳細

EndOfTurn

既定のターン終了の結果を取得します。

static EndOfTurn: DialogTurnResult

プロパティ値

DialogTurnResult

注釈

この結果は、ダイアログ (またはダイアログ内の論理ステップ) が現在のターンの処理を完了し、まだアクティブであり、より多くの入力を待機していることを示します。

Dialog.EndOfTurn から継承された

id 

id: string

プロパティ値

string

Dialog.id から継承された

telemetryClient 

telemetryClient: BotTelemetryClient

プロパティ値

BotTelemetryClient

Dialog.telemetryClient から継承された

メソッドの詳細

beginDialog(DialogContext, any)

ダイアログ が開始され、ダイアログ スタックにプッシュされたときに呼び出されます。

function beginDialog(dc: DialogContext, options?: any): Promise<DialogTurnResult>

パラメーター

dc

DialogContext

会話の現在のターンの DialogContext。

options

any

随意。 ダイアログに渡す初期情報。

戻り値

Promise<DialogTurnResult>

非同期操作を表す DialogTurnResultPromise。

continueDialog(DialogContext)

ダイアログ が継続 場合に呼び出されます。このダイアログはアクティブなダイアログで、ユーザーは新しいアクティビティで応答します。

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

パラメーター

dc

DialogContext

会話の現在のターンの DialogContext。

戻り値

Promise<DialogTurnResult>

非同期操作を表す DialogTurnResultPromise。

getConverter(Object) 

function getConverter(property: Object): Converter | ConverterFactory

パラメーター

property

Object

条件付きセレクター構成のキー。

戻り値

Converter | ConverterFactory

セレクター構成のコンバーター。

resumeDialog(DialogContext, DialogReason, any)

子 ダイアログ がターンを完了し、このダイアログに制御を返すと呼び出されます。

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

パラメーター

dc

DialogContext

会話の現在のターンの DialogContext。

_reason

DialogReason

(xref:botbuilder-dialogs。DialogReason)、ダイアログが再開された理由。

_result

any

随意。 呼び出された ダイアログ から返される値。 返される値の型は、子ダイアログに依存します。

戻り値

Promise<DialogTurnResult>

非同期操作を表す DialogTurnResultPromise。

継承済みメソッドの詳細

configure(Record<string, unknown>)

オブジェクトを構成するための Fluent メソッド。

function configure(config: Record<string, unknown>): this

パラメーター

config

Record<string, unknown>

適用する構成設定。

戻り値

this

操作が完了した後の 構成可能な。

継承 構成可能。configure

endDialog(TurnContext, DialogInstance, DialogReason)

派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

パラメーター

_context

TurnContext

ターンのコンテキスト オブジェクト。

_instance

DialogInstance

このダイアログの現在の状態情報。

_reason

DialogReason

ダイアログが終了する理由。

戻り値

Promise<void>

注釈

終了する前にログ記録またはクリーンアップを実行する必要がある派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドは無効です。

DialogContext は、現在のダイアログが終了するときにこのメソッドを呼び出します。

も参照

Dialog.endDialog から継承された

getVersion()

再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。

function getVersion(): string

戻り値

string

ダイアログを再起動する方法でダイアログが変更された場合にのみ変更する一意の文字列。

注釈

既定では、id ダイアログが返されますが、より正確な変更検出ロジックを提供するためにオーバーライドできます。 バージョンが変更されたスタック上のダイアログでは、versionChanged イベントが発生します。 このイベントがボットによって処理されない場合は、エラーがスローされ、ボットのエラー ハンドラー ロジックが実行されます。

空の文字列を返すと、コンポーネントのバージョン追跡がすべて無効になります。

Dialog.getVersion から継承された

onDialogEvent(DialogContext, DialogEvent)

現在のダイアログまたは現在のダイアログが開始したダイアログによって、DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

パラメーター

dc

DialogContext

会話の現在のターンのダイアログ コンテキスト。

e

DialogEvent

発生しているイベント。

戻り値

Promise<boolean>

True の 場合は、イベントが現在のダイアログで処理され、バブルを停止する必要があります。

Dialog.onDialogEvent から継承された

repromptDialog(TurnContext, DialogInstance)

派生クラスでオーバーライドされると、ユーザーに入力を要求します。

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

パラメーター

_context

TurnContext

ターンのコンテキスト オブジェクト。

_instance

DialogInstance

このダイアログの現在の状態情報。

戻り値

Promise<void>

注釈

検証ロジックと再プロンプト ロジックをサポートする派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドは無効です。

DialogContext は、現在のダイアログでユーザーからの入力を要求する必要があるときに、このメソッドを呼び出します。 このメソッドは、プロンプト ダイアログ用に実装されます。

も参照

Dialog.repromptDialog から継承された