ActivityPrompt class
Espera a que se reciba una actividad.
- Extends
Comentarios
Este mensaje requiere que se pase un validador y es útil cuando se esperan actividades que no son de mensaje como un evento que se va a recibir. El validador puede omitir los eventos recibidos hasta que se reciba la actividad esperada.
Constructores
| Activity |
Crea una nueva instancia de ActivityPrompt. |
Propiedades
| id | Identificador único del cuadro de diálogo. Establece el identificador único del cuadro de diálogo. |
| telemetry |
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
| End |
Obtiene un resultado predeterminado de fin de turno. |
Métodos
| begin |
Se llama cuando se inserta un cuadro de diálogo de solicitud en la pila de diálogos y se activa. |
| continue |
Se llama cuando un cuadro de diálogo de solicitud es el diálogo activo y el usuario respondió con una nueva actividad. |
| reprompt |
Se llama cuando se ha solicitado un cuadro de diálogo de solicitud para volver a solicitar al usuario la entrada. |
| resume |
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. |
Métodos heredados
| configure(Record<string, unknown>) | Método Fluent para configurar el objeto. |
| end |
Cuando se invalida en una clase derivada, realiza la limpieza del cuadro de diálogo antes de que finalice. |
| get |
|
| get |
Cadena codificada que se usa para ayudar a detectar los cambios del bot en la reimplempleción. |
| on |
Se llama cuando se ha generado un evento, mediante |
Detalles del constructor
ActivityPrompt(string, PromptValidator<Activity>)
Crea una nueva instancia de ActivityPrompt.
new ActivityPrompt(dialogId: string, validator: PromptValidator<Activity>)Parámetros
- dialogId
-
string
Identificador único del cuadro de diálogo dentro de su DialogSet primario o ComponentDialog.
- validator
-
PromptValidator<Activity>
Validador al que se llamará cada vez que se recibe una nueva actividad.
Detalles de las propiedades
id
Identificador único del cuadro de diálogo. Establece el identificador único del cuadro de diálogo.
string idValor de propiedad
string
Identificador del cuadro de diálogo.
Comentarios
Se generará automáticamente si no se especifica.
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 telemetryClientValor de propiedad
BotTelemetryClient
Detalles de las propiedades heredadas
EndOfTurn
Obtiene un resultado predeterminado de fin de turno.
static EndOfTurn: DialogTurnResultValor 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 dedialog.EndOfTurn
Detalles del método
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
El dialogContext de
- options
- PromptOptions
(xref:botbuilder-dialogs. 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 promesa se realiza correctamente, el resultado indica si la solicitud sigue activa después de que el aviso haya procesado el turno.
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
dialogContext para el turno actual de conversación.
Devoluciones
Promise<DialogTurnResult>
Un Promise que representa la operación asincrónica.
Comentarios
Si la promesa 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.
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.
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
El dialogContext de
- _reason
- DialogReason
(xref:botbuilder-dialogs. DialogReason), una enumeración que indica por qué se reanudó el 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>
Un Promise que representa la operación asincrónica.
Detalles de los métodos heredados
configure(Record<string, unknown>)
Método Fluent para configurar el objeto.
function configure(config: Record<string, unknown>): thisPará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
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 | ConverterFactoryParámetros
- _property
-
string
Clave de la configuración del selector condicional.
Devoluciones
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(): stringDevoluciones
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
Contexto del cuadro de diálogo para el turno actual de conversación.
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