ChoicePrompt class

Paquete:

botbuilder-dialogs

Pide a un usuario que seleccione una lista de opciones.

Extends

Prompt<FoundChoice>

Comentarios

De forma predeterminada, el símbolo del sistema volverá al cuadro de diálogo de llamada un objeto FoundChoice que contiene la opción seleccionada.

Constructores

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Crea una nueva instancia de ChoicePrompt.

Propiedades

choiceOptions	Opciones adicionales pasadas al ChoiceFactory y usadas para ajustar el estilo de las opciones representadas al usuario.
defaultLocale	La configuración regional predeterminada solicita que se reconozca.
id	Identificador único del cuadro de diálogo. Establece el identificador único del cuadro de diálogo.
recognizerOptions	Opciones adicionales que se pasan a la función recognizeChoices() subyacente.
style	Estilo de las opciones "sí" y "no" representadas al usuario al preguntar.
telemetryClient	Obtiene el cliente de telemetría para este cuadro de diálogo. Establece el cliente de telemetría para este cuadro de diálogo.

Propiedades heredadas

EndOfTurn

Obtiene un resultado predeterminado de fin de turno.

Métodos heredados

beginDialog(DialogContext, PromptOptions)	Se llama cuando se inserta un cuadro de diálogo de solicitud en la pila de diálogos y se activa.
configure(Record<string, unknown>)	Método Fluent para configurar el objeto.
continueDialog(DialogContext)	Se llama cuando un cuadro de diálogo de solicitud es el diálogo activo y el usuario respondió con una nueva actividad.
endDialog(TurnContext, DialogInstance, DialogReason)	Cuando se invalida en una clase derivada, realiza la limpieza del cuadro de diálogo antes de que finalice.
getConverter(string)
getVersion()	Cadena codificada que se usa para ayudar a detectar los cambios del bot en la reimplempleción.
onDialogEvent(DialogContext, DialogEvent)	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.
repromptDialog(TurnContext, DialogInstance)	Se llama cuando se ha solicitado un cuadro de diálogo de solicitud para volver a solicitar al usuario la entrada.
resumeDialog(DialogContext, DialogReason, any)	Se llama cuando un cuadro de diálogo de solicitud se reanuda como el diálogo activo en la pila de diálogos, como cuando se completa el diálogo activo anterior en la pila.

Detalles del constructor

ChoicePrompt(string, PromptValidator<FoundChoice>, string, ChoiceDefaultsChoicePrompt)

Crea una nueva instancia de ChoicePrompt.

new ChoicePrompt(dialogId: string, validator?: PromptValidator<FoundChoice>, defaultLocale?: string, choiceDefaults?: ChoiceDefaultsChoicePrompt)

Parámetros

dialogId

string

Identificador único del cuadro de diálogo dentro de su DialogSetprimario.

validator

PromptValidator<FoundChoice>

(Opcional) validador al que se llamará cada vez que el usuario responda al mensaje. Si el validador responde con un mensaje, no se enviará ningún mensaje de reintento adicional.

defaultLocale

string

(Opcional) configuración regional que se usará si no se especifica dc.context.activity.locale. El valor predeterminado es en-us.

choiceDefaults

ChoiceDefaultsChoicePrompt

(Opcional) Invalida el diccionario de _choiceDefaults compatibles con Bot Framework SDK (para la localización del mensaje). Debe pasarse a cada ConfirmPrompt que necesite los valores predeterminados de la elección personalizada.

Detalles de las propiedades

choiceOptions

Opciones adicionales pasadas al ChoiceFactory y usadas para ajustar el estilo de las opciones representadas al usuario.

choiceOptions: ChoiceFactoryOptions | undefined

Valor de propiedad

ChoiceFactoryOptions | undefined

defaultLocale

La configuración regional predeterminada solicita que se reconozca.

defaultLocale: string | undefined

Valor de propiedad

string | undefined

id

Identificador único del cuadro de diálogo. Establece el identificador único del cuadro de diálogo.

string id

Valor de propiedad

string

Identificador del cuadro de diálogo.

Comentarios

Se generará automáticamente si no se especifica.

recognizerOptions

Opciones adicionales que se pasan a la función recognizeChoices() subyacente.

recognizerOptions: FindChoicesOptions | undefined

Valor de propiedad

FindChoicesOptions | undefined

style

Estilo de las opciones "sí" y "no" representadas al usuario al preguntar.

style: ListStyle

Valor de propiedad

ListStyle

Comentarios

Su valor predeterminado es ListStyle.auto.

telemetryClient

Obtiene el cliente de telemetría para este cuadro de diálogo. Establece el cliente de telemetría para este cuadro de diálogo.

BotTelemetryClient telemetryClient

Valor de propiedad

BotTelemetryClient

BotTelemetryClient que se va a usar para el registro.

Detalles de las propiedades heredadas

EndOfTurn

Obtiene un resultado predeterminado de fin de turno.

static EndOfTurn: DialogTurnResult

Valor de propiedad

DialogTurnResult

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 dedialog.EndOfTurn

Detalles de los métodos heredados

beginDialog(DialogContext, PromptOptions)

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

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

Parámetros

dc

DialogContext

El dialogContext de para el turno actual de la conversación.

options

PromptOptions

Opcional. PromptOptions, información adicional para pasar al símbolo del sistema que se está iniciando.

Devoluciones

Promise<DialogTurnResult>

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

Comentarios

Si la tarea se realiza correctamente, el resultado indica si la solicitud sigue activa después de que el aviso haya sido procesado por el aviso.

heredado deprompt.beginDialog

configure(Record<string, unknown>)

Método Fluent para configurar el objeto.

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

Parámetros

config

Record<string, unknown>

Opciones de configuración que se van a aplicar.

Devoluciones

this

configurable una vez completada la operación.

heredado deconfigurable.configure

continueDialog(DialogContext)

Se llama cuando un cuadro de diálogo de solicitud es el diálogo activo y el usuario respondió con una nueva actividad.

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

Parámetros

dc

DialogContext

dialogContext para el turno actual de conversación.

Devoluciones

Promise<DialogTurnResult>

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

Comentarios

Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno. Por lo general, la solicitud sigue recibiendo las respuestas del usuario hasta que acepta la respuesta del usuario como entrada válida para el mensaje.

heredado deprompt.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

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

_context

TurnContext

Objeto de contexto del turno.

_instance

DialogInstance

Información de estado actual para este cuadro de diálogo.

_reason

DialogReason

Motivo por el que finaliza el cuadro de diálogo.

Devoluciones

Promise<void>

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 dedialog.endDialog

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

Parámetros

_property

string

Clave de la configuración del selector condicional.

Devoluciones

Converter | ConverterFactory

Convertidor para la configuración del selector.

heredado deconfigurable.getConverter

getVersion()

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

function getVersion(): string

Devoluciones

string

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 deDialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

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

dc

DialogContext

Contexto del cuadro de diálogo para el turno actual de conversación.

e

DialogEvent

Evento que se está generando.

Devoluciones

Promise<boolean>

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

Heredado deDialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Se llama cuando se ha solicitado un cuadro de diálogo de solicitud para volver a solicitar al usuario la entrada.

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

Parámetros

context

TurnContext

(xref:botbuilder-core. TurnContext), contexto para el turno actual de conversación con el usuario.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), la instancia del cuadro de diálogo en la pila.

Devoluciones

Promise<void>

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

heredado deprompt.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Se llama cuando un cuadro de diálogo de solicitud se reanuda como el diálogo activo en la pila de diálogos, como cuando se completa el diálogo activo anterior en la pila.

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

Parámetros

dc

DialogContext

DialogContext para el turno actual de la conversación.

_reason

DialogReason

Enumeración que indica por qué se reanudó el cuadro de diálogo.

_result

any

Opcional, valor devuelto del cuadro de diálogo anterior en la pila. El tipo del valor devuelto depende del cuadro de diálogo anterior.

Devoluciones

Promise<DialogTurnResult>

Promesa que representa la operación asincrónica.

Comentarios

Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno.

heredado deprompt.resumeDialog