HttpRequest class
HttpRequestを実行するためのアクション。
- Extends
-
Dialog<O>
コンストラクター
| Http |
HttpRequest クラスの新しいインスタンスを初期化します。 |
| Http |
HttpRequest クラスの新しいインスタンスを初期化します。 |
プロパティ
| $kind | |
| body | Http 本文 |
| content |
要求本文のコンテンツタイプ |
| disabled | true の場合は、このアクションを無効にする省略可能な式。 |
| headers | Http ヘッダー |
| method | Http メソッド |
| response |
応答の応答の種類 |
| result |
HTTP 応答を格納するプロパティ式を取得または設定します。 |
| url | Http Url |
継承されたプロパティ
| End |
既定のターン終了の結果を取得します。 |
| id | |
| telemetry |
メソッド
| begin |
新しい ダイアログ を開始し、ダイアログ スタックにプッシュします。 |
| get |
継承されたメソッド
| configure(Record<string, unknown>) | オブジェクトを構成するための Fluent メソッド。 |
| continue |
派生クラスでオーバーライドされた場合は、ダイアログを続行します。 |
| end |
派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。 |
| get |
再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。 |
| on |
現在のダイアログまたは現在のダイアログが開始したダイアログによって、 |
| reprompt |
派生クラスでオーバーライドされると、ユーザーに入力を要求します。 |
| resume |
派生クラスでオーバーライドされると、スタック上のダイアログが完了した後にダイアログを再開します。 |
コンストラクターの詳細
HttpRequest()
HttpRequest クラスの新しいインスタンスを初期化します。
new HttpRequest()
HttpRequest(HttpMethod, string, [key: string]: string, any)
HttpRequest クラスの新しいインスタンスを初期化します。
new HttpRequest(method: HttpMethod, url: string, headers: [key: string]: string, body: any)パラメーター
- method
- HttpMethod
HttpMethod(POST、GET、DELETE、PUT など)。
- url
-
string
要求の URL。
- headers
-
[key: string]: string
要求のヘッダー。
- body
-
any
要求の生本文。
プロパティの詳細
$kind
static $kind: stringプロパティ値
string
body
Http 本文
body?: ValueExpressionプロパティ値
ValueExpression
contentType
要求本文のコンテンツタイプ
contentType?: StringExpressionプロパティ値
StringExpression
disabled
true の場合は、このアクションを無効にする省略可能な式。
disabled?: BoolExpressionプロパティ値
BoolExpression
headers
Http ヘッダー
headers?: [key: string]: StringExpressionプロパティ値
[key: string]: StringExpression
method
responseType
resultProperty
HTTP 応答を格納するプロパティ式を取得または設定します。
resultProperty: StringExpressionプロパティ値
StringExpression
url
Http Url
url?: StringExpressionプロパティ値
StringExpression
継承されたプロパティの詳細
EndOfTurn
既定のターン終了の結果を取得します。
static EndOfTurn: DialogTurnResultプロパティ値
DialogTurnResult
注釈
この結果は、ダイアログ (またはダイアログ内の論理ステップ) が現在のターンの処理を完了し、まだアクティブであり、より多くの入力を待機していることを示します。
Dialog.EndOfTurn から継承された
id
id: stringプロパティ値
string
Dialog.id から継承された
telemetryClient
telemetryClient: BotTelemetryClientプロパティ値
BotTelemetryClient
Dialog.telemetryClient から継承された
メソッドの詳細
beginDialog(DialogContext, O)
新しい ダイアログ を開始し、ダイアログ スタックにプッシュします。
function beginDialog(dc: DialogContext, _options?: O): Promise<DialogTurnResult>パラメーター
- dc
-
DialogContext
会話の現在のターンの DialogContext。
- _options
-
O
随意。 ダイアログに渡す初期情報。
戻り値
Promise<DialogTurnResult>
非同期操作を表す Promise。
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactoryパラメーター
- property
-
Object
条件付きセレクター構成のキー。
戻り値
Converter | ConverterFactory
セレクター構成のコンバーター。
継承済みメソッドの詳細
configure(Record<string, unknown>)
オブジェクトを構成するための Fluent メソッド。
function configure(config: Record<string, unknown>): thisパラメーター
- config
-
Record<string, unknown>
適用する構成設定。
戻り値
this
操作が完了した後の 構成可能な。
継承 構成可能。configure
continueDialog(DialogContext)
派生クラスでオーバーライドされた場合は、ダイアログを続行します。
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>パラメーター
- dc
-
DialogContext
現在のダイアログ ターンのコンテキスト。
戻り値
Promise<DialogTurnResult>
ダイアログ ターンの結果を解決する Promise。
注釈
複数ターンの会話をサポートする派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドはダイアログが完了したことを通知し、返します。
DialogContext は、ダイアログを続行するときにこのメソッドを呼び出します。
このダイアログが完了したことをダイアログ コンテキストに通知するには、このメソッドを終了する前に DialogContext.endDialog
も参照
Dialog.continueDialog から継承された
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 から継承された
resumeDialog(DialogContext, DialogReason, any)
派生クラスでオーバーライドされると、スタック上のダイアログが完了した後にダイアログを再開します。
function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>パラメーター
- dc
-
DialogContext
現在のダイアログ ターンのコンテキスト。
- reason
-
DialogReason
ダイアログが再開される理由。 これは通常、DialogReason.endCalled
- result
-
any
随意。 終了したダイアログからの戻り値 (存在する場合)。
戻り値
Promise<DialogTurnResult>
ダイアログ ターンの結果を解決する Promise。
注釈
複数ターンの会話をサポートする派生ダイアログは、このメソッドをオーバーライドする必要があります。 既定では、このメソッドはダイアログが完了したことを通知し、返します。
DialogContext は、ダイアログを再開するときにこのメソッドを呼び出します。 スタック上の前のダイアログで値が返された場合、その値は result パラメーターにあります。
も参照
Dialog.resumeDialog から継承された