ForEach class
Ejecuta un conjunto de acciones una vez para cada elemento de una lista o colección en memoria.
- Extends
-
ActionScope<O>
Constructores
| For |
Inicializa una nueva instancia de la clase |
| For |
Inicializa una nueva instancia de la clase |
Propiedades
| $kind | |
| disabled | Una expresión opcional que, si es true, deshabilitará esta acción. |
| index | Expresión de ruta de acceso de propiedad al índice del elemento. |
| items |
Expresión de ruta de acceso de propiedad a la colección de elementos. |
| value | Expresión de ruta de acceso de propiedad al valor del elemento. |
Propiedades heredadas
| actions | Acciones que se van a ejecutar. |
| End |
Obtiene un resultado predeterminado de fin de turno. |
| id | |
| telemetry |
Métodos
| begin |
Inicia un nuevo cuadro de diálogo de y lo inserta en la pila de diálogos. |
| get |
|
| get |
Obtiene el cuadro de diálogo secundario dependencias para que se puedan agregar a los contenedores Cuadro de diálogo establecido. |
Métodos heredados
| 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 |
Obtiene un |
| 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 completó su turno, devolviendo el control a este cuadro de diálogo. |
Detalles del constructor
ForEach()
Inicializa una nueva instancia de la clase
new ForEach()
ForEach(string, Dialog[])
Inicializa una nueva instancia de la clase
new ForEach(itemsProperty: string, actions: Dialog[])
Parámetros
- itemsProperty
-
string
Expresión de ruta de acceso de propiedad a la colección de elementos.
- actions
-
Dialog[]
Acciones que se van a ejecutar.
Detalles de las propiedades
$kind
static $kind: string
Valor de propiedad
string
disabled
Una expresión opcional que, si es true, deshabilitará esta acción.
disabled?: BoolExpression
Valor de propiedad
BoolExpression
index
Expresión de ruta de acceso de propiedad al índice del elemento.
index: StringExpression
Valor de propiedad
StringExpression
itemsProperty
Expresión de ruta de acceso de propiedad a la colección de elementos.
itemsProperty: StringExpression
Valor de propiedad
StringExpression
value
Expresión de ruta de acceso de propiedad al valor del elemento.
value: StringExpression
Valor de propiedad
StringExpression
Detalles de las propiedades heredadas
actions
Acciones que se van a ejecutar.
actions: Dialog[]
Valor de propiedad
Dialog[]
Heredado deActionScope.actions
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
telemetryClient
telemetryClient: BotTelemetryClient
Valor de propiedad
BotTelemetryClient
Heredado de Dialog.telemetryClient
Detalles del método
beginDialog(DialogContext, O)
Inicia un nuevo cuadro de diálogo de y lo inserta en la pila de diálogos.
function beginDialog(dc: DialogContext, _options?: O): Promise<DialogTurnResult>
Parámetros
- dc
-
DialogContext
dialogContext para el turno actual de conversación.
- _options
-
O
Opcional. Información inicial que se va a pasar al cuadro de diálogo.
Devoluciones
Promise<DialogTurnResult>
Un Promise que representa la operación asincrónica.
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.
getDependencies()
Obtiene el cuadro de diálogo secundario dependencias para que se puedan agregar a los contenedores Cuadro de diálogo establecido.
function getDependencies(): Dialog[]
Devoluciones
Dialog[]
Dependencias del cuadro de diálogo de secundario.
Detalles de los métodos heredados
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 Promise que representa la operación asincrónica.
heredado deActionScope.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()
Obtiene un string único que representa la versión de este cuadro de diálogo. Si la versión cambia entre turnos, el sistema de diálogo emitirá un evento DialogChanged.
function getVersion(): string
Devoluciones
string
Único string que solo debe cambiar cuando el cuadro de diálogo ha cambiado de una manera que debe reiniciar el diálogo.
Heredado deActionScope.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 completó 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 desde el cuadro de diálogo al que se llamó. El tipo del valor devuelto depende del cuadro de diálogo secundario.
Devoluciones
Promise<DialogTurnResult>
Un Promise que representa la operación asincrónica.
Heredado deActionScope.resumeDialog