OAuthInput class

初始化 OAuthInput 类的新实例

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

参数

static $kind: string

属性值

正在使用的 OAuth 连接的名称。

connectionName: StringExpression

属性值

（可选）要包括在登录卡上的其他文本。

text?: StringExpression

属性值

（可选）提示等待用户进行身份验证的毫秒数。 默认值为值 900,000（15 分钟）。

timeout?: IntExpression

属性值

卡片登录按钮的标题。

title: StringExpression

属性值

中断策略。

allowInterruptions: BoolExpression

属性值

继承自InputDialog.allowInterruptions

一个值，该值指示输入是否应始终提示用户，而不考虑是否存在值。

alwaysPrompt: BoolExpression

属性值

继承自InputDialog.alwaysPrompt

超出 maxTurnCount 时输入对话框的默认值。

defaultValue?: ValueExpression

属性值

继承自InputDialog.defaultValue

达到 maxTurnCount 且使用默认值时要发送的活动模板。

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

属性值

继承自InputDialog.defaultValueResponse

如果为 true，则为 true 的可选表达式将禁用此操作。

disabled?: BoolExpression

属性值

继承自InputDialog.disabled

获取默认的轮次结束结果。

static EndOfTurn: DialogTurnResult

属性值

注解

此结果指示对话（或对话中的逻辑步骤）已完成当前轮次的处理，仍然处于活动状态，并且正在等待更多输入。

继承自 Dialog.EndOfTurn

id: string

属性值

继承自 Dialog.id 的

每当提供的值无效或无效时，要发送给用户的活动模板。

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

属性值

继承自InputDialog.invalidPrompt

在对话框放弃之前请求用户提供此值的最大次数。

maxTurnCount?: IntExpression

属性值

继承自InputDialog.maxTurnCount

static OPTIONS_PROPERTY: string

属性值

继承自 InputDialog.OPTIONS_PROPERTY 的

要发送给用户的活动。

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

属性值

继承自InputDialog.prompt

输入将绑定到的值表达式。

property: StringExpression

属性值

继承自InputDialog.property

telemetryClient: BotTelemetryClient

属性值

继承自 Dialog.telemetryClient

static TURN_COUNT_PROPERTY: string

属性值

继承自 InputDialog.TURN_COUNT_PROPERTY 的

用于重试提示的活动模板。

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

属性值

继承自InputDialog.unrecognizedPrompt

要运行的表达式用于验证输入。

validations: string[]

属性值

继承自InputDialog.validations

可用于初始化输入提示的值表达式。

value: ValueExpression

属性值

继承自InputDialog.value

static VALUE_PROPERTY: string

属性值

继承自 InputDialog.VALUE_PROPERTY 的

当将提示 对话框 推送到对话堆栈并正在激活时调用。

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

参数

返回

表示异步作的 DialogTurnResultPromise。

当提示 对话框 是活动对话框，并且用户用新活动答复时调用。

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

参数

返回

表示异步作的 DialogTurnResultPromise。

function getConverter(property: Object): Converter | ConverterFactory

参数

返回

选择器配置的转换器。

尝试检索当前用户的存储令牌。

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

参数

返回

表示异步操作的 promise。

将用户注销服务。

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

参数

返回

表示异步操作的 promise。

注解

此示例演示如何创建提示实例，然后注销用户。

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

用于配置对象的 Fluent 方法。

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

参数

返回

操作完成后 可配置。

继承自 Configure.configure

在派生类中重写时，在对话结束之前执行清理。

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

参数

返回

注解

在结束之前需要执行日志记录或清理的派生对话应重写此方法。 默认情况下，此方法不起作用。

当当前对话结束时，DialogContext 调用此方法。

另请参阅

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

继承自 Dialog.endDialog

用于帮助在重新部署时检测机器人更改的编码字符串。

function getVersion(): string

返回

唯一字符串，仅当对话发生更改时，才应以重启对话框的方式更改。

注解

这默认返回对话 ID，但可以重写以提供更精确的更改检测逻辑。 堆栈上具有其版本更改的任何对话框都将导致引发 versionChanged 事件。 如果机器人未处理此事件，将引发错误，从而导致运行机器人错误处理程序逻辑。

返回空字符串将一起禁用组件的版本跟踪。

继承自 Dialog.getVersion

通过使用当前对话或当前对话启动的对话，使用 DialogContext.emitEvent()引发事件时调用。

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

参数

返回

如此 如果事件由当前对话框处理，并且冒泡应停止。

继承自 Dialog.onDialogEvent

在派生类中重写时，将用户重新分配输入。

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

参数

返回

注解

支持验证和重新提示逻辑的派生对话应重写此方法。 默认情况下，此方法不起作用。

DialogContext 在当前对话应从用户重新请求输入时调用此方法。 此方法是针对提示对话实现的。

另请参阅

• DialogContext.repromptDialog
• 提示

继承自 Dialog.repromptDialog

子 对话框 完成轮次时调用，将控件返回到此对话。

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

参数

返回

表示异步作的 DialogTurnResultPromise。

继承自 InputDialog.resumeDialog 的