DateTimeInput class
Cuadro de diálogo de entrada para recopilar una fecha y hora del usuario.
- Extends
Constructores
| Date |
Inicializa una nueva instancia de la clase InputDialog |
Propiedades
| $kind | |
| default |
|
| output |
Propiedades heredadas
| allow |
Directiva de interrupción. |
| always |
Valor que indica si la entrada siempre debe preguntar al usuario independientemente de que haya un valor o no. |
| default |
Valor predeterminado del cuadro de diálogo de entrada cuando se supera maxTurnCount. |
| default |
Plantilla de actividad que se va a enviar cuando se ha alcanzado maxTurnCount y se usa el valor predeterminado. |
| disabled | Una expresión opcional que, si es true, deshabilitará esta acción. |
| End |
Obtiene un resultado predeterminado de fin de turno. |
| id | |
| invalid |
Plantilla de actividad que se va a enviar al usuario siempre que el valor proporcionado no sea válido o no. |
| max |
Número máximo de veces que se le pide al usuario este valor antes de que se despiese el cuadro de diálogo. |
| OPTIONS_PROPERTY | |
| prompt | Actividad que se va a enviar al usuario. |
| property | Expresión de valor a la que se enlazará la entrada. |
| telemetry |
|
| TURN_COUNT_PROPERTY | |
| unrecognized |
Plantilla de actividad para volver a intentar la solicitud. |
| validations | Expresiones que se van a ejecutar para validar la entrada. |
| value | Expresión de valor que se puede usar para inicializar el símbolo del sistema de entrada. |
| VALUE_PROPERTY |
Métodos
| get |
Métodos heredados
| begin |
Se llama cuando se inicia el cuadro de diálogo de y se inserta en la pila de diálogos. |
| configure(Record<string, unknown>) | Método Fluent para configurar el objeto. |
| continue |
Se llama cuando el cuadro de diálogo de es continua, donde es el cuadro de diálogo activo y el usuario responde con una nueva actividad. |
| end |
Cuando se invalida en una clase derivada, realiza la limpieza del cuadro de diálogo antes de que finalice. |
| 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 |
| reprompt |
Cuando se invalida en una clase derivada, reprote el usuario para la entrada. |
| resume |
Se llama cuando un cuadro de diálogo secundario completa su turno, devolviendo el control a este cuadro de diálogo. |
Detalles del constructor
DateTimeInput(string, Partial<Activity> | string)
Inicializa una nueva instancia de la clase InputDialog
new DateTimeInput(property?: string, prompt?: Partial<Activity> | string)
Parámetros
- property
-
string
Opcional. Expresión de valor a la que se enlazará la entrada.
- prompt
-
Partial<Activity> | string
Opcional. El actividad de
Detalles de las propiedades
$kind
static $kind: string
Valor de propiedad
string
defaultLocale
defaultLocale: StringExpression
Valor de propiedad
StringExpression
outputFormat
outputFormat: StringExpression
Valor de propiedad
StringExpression
Detalles de las propiedades heredadas
allowInterruptions
Directiva de interrupción.
allowInterruptions: BoolExpression
Valor de propiedad
BoolExpression
Heredado deInputDialog.allowInterruptions
alwaysPrompt
Valor que indica si la entrada siempre debe preguntar al usuario independientemente de que haya un valor o no.
alwaysPrompt: BoolExpression
Valor de propiedad
BoolExpression
Heredado deInputDialog.alwaysPrompt
defaultValue
Valor predeterminado del cuadro de diálogo de entrada cuando se supera maxTurnCount.
defaultValue?: ValueExpression
Valor de propiedad
ValueExpression
heredado deinputDialog.defaultValue
defaultValueResponse
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
TemplateInterface<Partial<Activity>, DialogStateManager>
heredado deinputDialog.defaultValueResponse
disabled
Una expresión opcional que, si es true, deshabilitará esta acción.
disabled?: BoolExpression
Valor de propiedad
BoolExpression
heredado deinputDialog.disabled
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 de dialog.EndOfTurn
id
id: string
Valor de propiedad
string
heredado de Dialog.id
invalidPrompt
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
TemplateInterface<Partial<Activity>, DialogStateManager>
heredado deinputDialog.invalidPrompt
maxTurnCount
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
IntExpression
Heredado deInputDialog.maxTurnCount
OPTIONS_PROPERTY
prompt
Actividad que se va a enviar al usuario.
prompt: TemplateInterface<Partial<Activity>, DialogStateManager>
Valor de propiedad
TemplateInterface<Partial<Activity>, DialogStateManager>
heredado deinputDialog.prompt
property
Expresión de valor a la que se enlazará la entrada.
property: StringExpression
Valor de propiedad
StringExpression
heredado deinputDialog.property
telemetryClient
telemetryClient: BotTelemetryClient
Valor de propiedad
BotTelemetryClient
Heredado de Dialog.telemetryClient
TURN_COUNT_PROPERTY
static TURN_COUNT_PROPERTY: string
Valor de propiedad
string
heredado deInputDialog.TURN_COUNT_PROPERTY
unrecognizedPrompt
Plantilla de actividad para volver a intentar la solicitud.
unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>
Valor de propiedad
TemplateInterface<Partial<Activity>, DialogStateManager>
Heredado deInputDialog.unrecognizedPrompt
validations
Expresiones que se van a ejecutar para validar la entrada.
validations: string[]
Valor de propiedad
string[]
heredado deinputDialog.validations
value
Expresión de valor que se puede usar para inicializar el símbolo del sistema de entrada.
value: ValueExpression
Valor de propiedad
ValueExpression
se hereda deinputDialog.value
VALUE_PROPERTY
Detalles del método
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactory
Parámetros
- property
-
Object
Clave de la configuración del selector condicional.
Devoluciones
Converter | ConverterFactory
Convertidor para la configuración del selector.
Detalles de los métodos heredados
beginDialog(DialogContext, any)
Se llama cuando se inicia el cuadro de diálogo de y se inserta en la pila de diálogos.
function beginDialog(dc: DialogContext, options?: any): Promise<DialogTurnResult>
Parámetros
- dc
-
DialogContext
dialogContext para el turno actual de conversación.
Devoluciones
Promise<DialogTurnResult>
Un DialogTurnResultPromise que representa la operación asincrónica.
heredado deinputDialog.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 de Configurable.configure
continueDialog(DialogContext)
Se llama cuando el cuadro de diálogo de es continua, donde es el cuadro de diálogo activo y el usuario responde 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 DialogTurnResultPromise que representa la operación asincrónica.
heredado deinputDialog.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 de Dialog.endDialog
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 de Dialog.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 de Dialog.onDialogEvent
repromptDialog(TurnContext, DialogInstance)
Cuando se invalida en una clase derivada, reprote el usuario para la entrada.
function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>
Parámetros
- _context
-
TurnContext
Objeto de contexto del turno.
- _instance
-
DialogInstance
Información de estado actual para este cuadro de diálogo.
Devoluciones
Promise<void>
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
resumeDialog(DialogContext, DialogReason, any)
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
- dc
-
DialogContext
dialogContext para el turno actual de conversación.
- _reason
-
DialogReason
(xref:botbuilder-dialogs. DialogReason), motivo por el que se reanudó el diálogo.
- _result
-
any
Opcional. Valor devuelto del cuadro de diálogo de al que se llamó. El tipo del valor devuelto depende del cuadro de diálogo secundario.
Devoluciones
Promise<DialogTurnResult>
Un DialogTurnResultPromise que representa la operación asincrónica.
heredado deinputDialog.resumeDialog