OAuthInput class

リファレンス

パッケージ:: botbuilder-dialogs-adaptive

OAuthInput は、ユーザーにログインを求めます。

Extends: InputDialog

コンストラクター

OAuthInput(string, string, string, number)

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

プロパティ

$kind
connectionName	使用されている OAuth 接続の名前。
text	(省略可能) サインインカードに含める追加のテキスト。
timeout	(省略可能) プロンプトがユーザーの認証を待機するミリ秒数。既定値は値 `900,000` (15 分) です。
title	カードのサインインボタンのタイトル。

継承されたプロパティ

allowInterruptions	割り込みポリシー。
alwaysPrompt	値があるかどうかに関係なく、入力で常にユーザーにプロンプトを表示するかどうかを示す値。
defaultValue	maxTurnCount を超えた場合の入力ダイアログの既定値。
defaultValueResponse	maxTurnCount に達し、既定値が使用されたときに送信するアクティビティテンプレート。
disabled	true の場合は、このアクションを無効にする省略可能な式。
EndOfTurn	既定のターン終了の結果を取得します。
id
invalidPrompt	指定された値が無効かどうかに関係なく、ユーザーに送信するアクティビティテンプレート。
maxTurnCount	ダイアログが終了するまでにユーザーにこの値を要求する最大回数。
OPTIONS_PROPERTY
prompt	ユーザーに送信するアクティビティ。
property	入力のバインド先となる値式。
telemetryClient
TURN_COUNT_PROPERTY
unrecognizedPrompt	再試行プロンプトのアクティビティテンプレート。
validations	入力を検証するために実行する式。
value	入力プロンプトを初期化するために使用できる値式。
VALUE_PROPERTY

メソッド

beginDialog(DialogContext, PromptOptions)	ダイアログプロンプトがダイアログスタックにプッシュされ、アクティブ化されるときに呼び出されます。
continueDialog(DialogContext)	ダイアログプロンプトがアクティブなダイアログであり、ユーザーが新しいアクティビティで応答したときに呼び出されます。
getConverter(Object)
getUserToken(DialogContext, string)	現在のユーザーの格納されているトークンの取得を試みます。
signOutUser(DialogContext)	ユーザーをサービスからサインアウトします。

継承されたメソッド

configure(Record<string, unknown>)	オブジェクトを構成するための Fluent メソッド。
endDialog(TurnContext, DialogInstance, DialogReason)	派生クラスでオーバーライドされると、ダイアログが終了する前にクリーンアップを実行します。
getVersion()	再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。
onDialogEvent(DialogContext, DialogEvent)	現在のダイアログまたは現在のダイアログが開始したダイアログによって、`DialogContext.emitEvent()`を使用してイベントが発生したときに呼び出されます。
repromptDialog(TurnContext, DialogInstance)	派生クラスでオーバーライドされると、ユーザーに入力を要求します。
resumeDialog(DialogContext, DialogReason, any)	子ダイアログがターンを完了し、このダイアログに制御を返すと呼び出されます。

コンストラクターの詳細

OAuthInput(string, string, string, number)

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

new OAuthInput(connectionName?: string, title?: string, text?: string, timeout?: number)

パラメーター

connectionName: string

随意。使用されている OAuth 接続の名前。

title: string

随意。カードのサインインボタンのタイトル。

text: string

随意。サインインカードに含める追加のテキスト。

timeout: number

随意。プロンプトがユーザーの認証を待機する時間 (ミリ秒)。

プロパティの詳細

$kind

static $kind: string

プロパティ値

string

connectionName

使用されている OAuth 接続の名前。

connectionName: StringExpression

プロパティ値

StringExpression

text

(省略可能) サインインカードに含める追加のテキスト。

text?: StringExpression

プロパティ値

StringExpression

timeout

(省略可能) プロンプトがユーザーの認証を待機するミリ秒数。既定値は値 900,000 (15 分) です。

timeout?: IntExpression

プロパティ値

IntExpression

title

カードのサインインボタンのタイトル。

title: StringExpression

プロパティ値

StringExpression

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

allowInterruptions

割り込みポリシー。

allowInterruptions: BoolExpression

プロパティ値

BoolExpression

InputDialog.allowInterruptions から継承された

alwaysPrompt

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

alwaysPrompt: BoolExpression

プロパティ値

BoolExpression

InputDialog.alwaysPrompt から継承された

defaultValue

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

defaultValue?: ValueExpression

プロパティ値

ValueExpression

InputDialog.defaultValue から継承された

defaultValueResponse

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

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

プロパティ値

TemplateInterface<Partial<Activity>, DialogStateManager>

inputDialog.defaultValueResponse から継承

disabled

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

disabled?: BoolExpression

プロパティ値

BoolExpression

InputDialog.disabled から継承された

EndOfTurn

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

static EndOfTurn: DialogTurnResult

プロパティ値

DialogTurnResult

注釈

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

Dialog.EndOfTurn から継承された

id

id: string

プロパティ値

string

Dialog.id から継承された

invalidPrompt

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

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

プロパティ値

TemplateInterface<Partial<Activity>, DialogStateManager>

InputDialog.invalidPrompt から継承

maxTurnCount

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

maxTurnCount?: IntExpression

プロパティ値

IntExpression

InputDialog.maxTurnCount から継承された

OPTIONS_PROPERTY

static OPTIONS_PROPERTY: string

プロパティ値

string

継承されたInputDialog.OPTIONS_PROPERTY

prompt

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

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

プロパティ値

TemplateInterface<Partial<Activity>, DialogStateManager>

inputDialog.prompt から継承

property

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

property: StringExpression

プロパティ値

StringExpression

InputDialog.property から継承

telemetryClient

telemetryClient: BotTelemetryClient

プロパティ値

BotTelemetryClient

Dialog.telemetryClient から継承された

TURN_COUNT_PROPERTY

static TURN_COUNT_PROPERTY: string

プロパティ値

string

InputDialog.TURN_COUNT_PROPERTY から継承された

unrecognizedPrompt

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

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

プロパティ値

TemplateInterface<Partial<Activity>, DialogStateManager>

InputDialog.unrecognizedPrompt から継承された

validations

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

validations: string[]

プロパティ値

string[]

InputDialog.validations から継承された

value

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

value: ValueExpression

プロパティ値

ValueExpression

inputDialog.value から継承

VALUE_PROPERTY

static VALUE_PROPERTY: string

プロパティ値

string

InputDialog.VALUE_PROPERTY から継承された

メソッドの詳細

beginDialog(DialogContext, PromptOptions)

ダイアログプロンプトがダイアログスタックにプッシュされ、アクティブ化されるときに呼び出されます。

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

パラメーター

dc: DialogContext

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

options: PromptOptions

随意。開始中のプロンプトに渡す追加情報。

戻り値

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

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

getUserToken(DialogContext, string)

現在のユーザーの格納されているトークンの取得を試みます。

function getUserToken(dc: DialogContext, code?: string): Promise<TokenResponse | undefined>

パラメーター

dc: DialogContext

コンテキストは、検索対象のユーザーを参照します。

code: string

(省略可能) ユーザーから受信したログインコード。

戻り値

Promise<TokenResponse | undefined>

非同期操作を表す Promise。

signOutUser(DialogContext)

ユーザーをサービスからサインアウトします。

function signOutUser(dc: DialogContext): Promise<void>

パラメーター

dc: DialogContext

サインアウトしているユーザーを参照するコンテキスト。

戻り値

Promise<void>

非同期操作を表す Promise。

注釈

この例では、プロンプトのインスタンスを作成し、ユーザーをサインアウトする方法を示します。

const prompt = new OAuthPrompt({
    connectionName: 'GitConnection',
    title: 'Login To GitHub'
});
await prompt.signOutUser(context);

継承済みメソッドの詳細

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 から継承された

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。

inputDialog.resumeDialog から継承

次の方法で共有

OAuthInput class

コンストラクター

プロパティ

継承されたプロパティ

メソッド

継承されたメソッド

コンストラクターの詳細

OAuthInput(string, string, string, number)

パラメーター

プロパティの詳細

$kind

プロパティ値

connectionName

プロパティ値

text

プロパティ値

timeout

プロパティ値

title

プロパティ値

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

allowInterruptions

プロパティ値

alwaysPrompt

プロパティ値

defaultValue

プロパティ値

defaultValueResponse

プロパティ値

disabled

プロパティ値

EndOfTurn

プロパティ値

注釈

id

プロパティ値

invalidPrompt

プロパティ値

maxTurnCount

プロパティ値

OPTIONS_PROPERTY

プロパティ値

prompt

プロパティ値

property

プロパティ値

telemetryClient

プロパティ値

TURN_COUNT_PROPERTY

プロパティ値

unrecognizedPrompt

プロパティ値

validations

プロパティ値

value

プロパティ値

VALUE_PROPERTY

プロパティ値

メソッドの詳細

beginDialog(DialogContext, PromptOptions)

パラメーター

戻り値

continueDialog(DialogContext)

パラメーター

戻り値

getConverter(Object)

パラメーター

戻り値

getUserToken(DialogContext, string)

パラメーター

戻り値

signOutUser(DialogContext)

パラメーター

戻り値

注釈

継承済みメソッドの詳細

configure(Record<string, unknown>)

パラメーター

戻り値