OAuthInput class

Inicializa una nueva instancia de la clase de OAuthInput

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

Parámetros

static $kind: string

Valor de propiedad

Nombre de la conexión de OAuth que se usa.

connectionName: StringExpression

Valor de propiedad

(Opcional) texto adicional que se va a incluir en la tarjeta de inicio de sesión.

text?: StringExpression

Valor de propiedad

(Opcional) número de milisegundos que el mensaje esperará a que el usuario se autentique. El valor predeterminado es un valor 900,000 (15 minutos).

timeout?: IntExpression

Valor de propiedad

Título del botón de inicio de sesión de tarjetas.

title: StringExpression

Valor de propiedad

Directiva de interrupción.

allowInterruptions: BoolExpression

Valor de propiedad

Heredado deInputDialog.allowInterruptions

Valor que indica si la entrada siempre debe preguntar al usuario independientemente de que haya un valor o no.

alwaysPrompt: BoolExpression

Valor de propiedad

Heredado deInputDialog.alwaysPrompt

Valor predeterminado del cuadro de diálogo de entrada cuando se supera maxTurnCount.

defaultValue?: ValueExpression

Valor de propiedad

heredado deinputDialog.defaultValue

Plantilla de actividad que se va a enviar cuando se ha alcanzado maxTurnCount y se usa el valor predeterminado.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor de propiedad

heredado deinputDialog.defaultValueResponse

Una expresión opcional que, si es true, deshabilitará esta acción.

disabled?: BoolExpression

Valor de propiedad

heredado deinputDialog.disabled

Obtiene un resultado predeterminado de fin de turno.

static EndOfTurn: DialogTurnResult

Valor de propiedad

Comentarios

Este resultado indica que un cuadro de diálogo (o un paso lógico dentro de un diálogo) ha completado el procesamiento del turno actual, sigue activo y está esperando más entradas.

heredado de dialog.EndOfTurn

id: string

Valor de propiedad

heredado de Dialog.id

Plantilla de actividad que se va a enviar al usuario siempre que el valor proporcionado no sea válido o no.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor de propiedad

heredado deinputDialog.invalidPrompt

Número máximo de veces que se le pide al usuario este valor antes de que se despiese el cuadro de diálogo.

maxTurnCount?: IntExpression

Valor de propiedad

Heredado deInputDialog.maxTurnCount

static OPTIONS_PROPERTY: string

Valor de propiedad

heredado deInputDialog.OPTIONS_PROPERTY

Actividad que se va a enviar al usuario.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor de propiedad

heredado deinputDialog.prompt

Expresión de valor a la que se enlazará la entrada.

property: StringExpression

Valor de propiedad

heredado deinputDialog.property

telemetryClient: BotTelemetryClient

Valor de propiedad

Heredado de Dialog.telemetryClient

static TURN_COUNT_PROPERTY: string

Valor de propiedad

heredado deInputDialog.TURN_COUNT_PROPERTY

Plantilla de actividad para volver a intentar la solicitud.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor de propiedad

Heredado deInputDialog.unrecognizedPrompt

Expresiones que se van a ejecutar para validar la entrada.

validations: string[]

Valor de propiedad

heredado deinputDialog.validations

Expresión de valor que se puede usar para inicializar el símbolo del sistema de entrada.

value: ValueExpression

Valor de propiedad

se hereda deinputDialog.value

static VALUE_PROPERTY: string

Valor de propiedad

heredado deInputDialog.VALUE_PROPERTY

Se llama cuando se inserta una solicitud cuadro de diálogo en la pila de diálogos y se activa.

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

Parámetros

Devoluciones

Un DialogTurnResultPromise que representa la operación asincrónica.

Se llama cuando un mensaje Dialog es el diálogo activo y el usuario respondió con una nueva actividad.

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

Parámetros

Devoluciones

Un DialogTurnResultPromise que representa la operación asincrónica.

function getConverter(property: Object): Converter | ConverterFactory

Parámetros

Devoluciones

Convertidor para la configuración del selector.

Intenta recuperar el token almacenado para el usuario actual.

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

Parámetros

Devoluciones

Promesa que representa la operación asincrónica.

Cierra la sesión del usuario del servicio.

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

Parámetros

Devoluciones

Promesa que representa la operación asincrónica.

Comentarios

En este ejemplo se muestra cómo crear una instancia del símbolo del sistema y, a continuación, cerrar la sesión del usuario.

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

Método Fluent para configurar el objeto.

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

Parámetros

Devoluciones

configurable una vez completada la operación.

Heredado de Configurable.configure

Cuando se invalida en una clase derivada, realiza la limpieza del cuadro de diálogo antes de que finalice.

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

Parámetros

Devoluciones

Comentarios

Los diálogos derivados que necesitan realizar el registro o la limpieza antes de finalizar deben invalidar este método. De forma predeterminada, este método no tiene ningún efecto.

El DialogContext llama a este método cuando finaliza el diálogo actual.

Consulte también

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

Heredado de Dialog.endDialog

Cadena codificada que se usa para ayudar a detectar los cambios del bot en la reimplempleción.

function getVersion(): string

Devoluciones

Cadena única que solo debe cambiar cuando el cuadro de diálogo ha cambiado de una manera que debe reiniciar el diálogo.

Comentarios

Este valor predeterminado es devolver los cuadros de diálogo id, pero se puede invalidar para proporcionar lógica de detección de cambios más precisa. Cualquier cuadro de diálogo de la pila que tenga su cambio de versión producirá un evento versionChanged. Si el bot no controla este evento, se producirá un error que dará lugar a la ejecución de la lógica del controlador de errores de bots.

Al devolver una cadena vacía, se deshabilitará el seguimiento de versiones para el componente en conjunto.

Heredado de Dialog.getVersion

Se llama cuando se ha generado un evento, mediante DialogContext.emitEvent(), mediante el cuadro de diálogo actual o un diálogo que inició el diálogo actual.

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

Parámetros

Devoluciones

True si el diálogo actual controla el evento y se debe detener la propagación.

Heredado de Dialog.onDialogEvent

Cuando se invalida en una clase derivada, reprote el usuario para la entrada.

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

Parámetros

Devoluciones

Comentarios

Los diálogos derivados que admiten la validación y la lógica de nueva solicitud deben invalidar este método. De forma predeterminada, este método no tiene ningún efecto.

El DialogContext llama a este método cuando el diálogo actual debe volver a solicitar la entrada del usuario. Este método se implementa para los cuadros de diálogo de solicitud.

Consulte también

• dialogContext.repromptDialog
• prompt

Heredado de Dialog.repromptDialog

Se llama cuando un cuadro de diálogo secundario completa su turno, devolviendo el control a este cuadro de diálogo.

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

Parámetros

Devoluciones

Un DialogTurnResultPromise que representa la operación asincrónica.

heredado deinputDialog.resumeDialog