SkillDialog class
Cuadro de diálogo especializado que puede encapsular llamadas remotas a una aptitud.
- Extends
-
Dialog<Partial<BeginSkillDialogOptions>>
Comentarios
El parámetro options de beginDialog debe ser una instancia BeginSkillDialogOptions con los parámetros iniciales del cuadro de diálogo.
Constructores
| Skill |
Cuadro de diálogo de ejemplo que puede encapsular llamadas remotas a una aptitud. |
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 inicia y se inserta el cuadro de diálogo de aptitud en la pila de diálogos. |
| continue |
Se llama cuando el cuadro de diálogo de aptitud se continua, donde es el diálogo activo y el usuario responde con una nueva actividad de . |
| end |
Se llama cuando finaliza el cuadro de diálogo de aptitud. |
| reprompt |
Se llama cuando el cuadro de diálogo de aptitud debe volver a solicitar al usuario la entrada. |
| resume |
Se llama cuando un cuadro de diálogo de aptitud secundaria ha completado su turno y devuelve el control a este diálogo. |
Métodos heredados
| configure(Record<string, unknown>) | Método Fluent para configurar el objeto. |
| 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
SkillDialog(SkillDialogOptions, string)
Cuadro de diálogo de ejemplo que puede encapsular llamadas remotas a una aptitud.
new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)Parámetros
- dialogOptions
- SkillDialogOptions
Las opciones para ejecutar el cuadro de diálogo de aptitud.
- dialogId
-
string
Identificador del cuadro de diálogo.
Comentarios
El parámetro options de beginDialog() debe ser un objeto SkillDialogArgs con los parámetros iniciales del cuadro de diálogo.
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, BeginSkillDialogOptions)
Se llama cuando se inicia y se inserta el cuadro de diálogo de aptitud en la pila de diálogos.
function beginDialog(dc: DialogContext, options: BeginSkillDialogOptions): Promise<DialogTurnResult>Parámetros
dialogContext para el turno actual de conversación.
- options
- BeginSkillDialogOptions
Información inicial que se va a pasar al cuadro de diálogo.
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.
continueDialog(DialogContext)
Se llama cuando el cuadro de diálogo de aptitud se continua, donde es el diálogo activo y el usuario responde con una nueva actividad de .
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>Parámetros
dialogContext para el turno actual de conversación.
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. El resultado también puede contener un valor devuelto.
endDialog(TurnContext, DialogInstance, DialogReason)
Se llama cuando finaliza el cuadro de diálogo de aptitud.
function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>Parámetros
- context
-
TurnContext
Objeto TurnContext para este turno.
- instance
- DialogInstance
Información de estado asociada a la instancia de este cuadro de diálogo en la pila de diálogos.
- reason
- DialogReason
(xref:botbuilder-dialogs. DialogReason) por qué finalizó el diálogo.
Devoluciones
Promise<void>
Promesa que representa la operación asincrónica.
repromptDialog(TurnContext, DialogInstance)
Se llama cuando el cuadro de diálogo de aptitud debe volver a solicitar al usuario la entrada.
function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>Parámetros
- context
-
TurnContext
Objeto TurnContext para este turno.
- instance
- DialogInstance
Información de estado de este cuadro de diálogo.
Devoluciones
Promise<void>
Promesa que representa la operación asincrónica.
resumeDialog(DialogContext, DialogReason, any)
Se llama cuando un cuadro de diálogo de aptitud secundaria ha completado su turno y devuelve el control a este diálogo.
function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>Parámetros
El dialogContext de
- _reason
- DialogReason
(xref:botbuilder-dialogs. DialogReason) por qué se reanudó el diálogo.
- _result
-
any
Opcional, el 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>
Promesa 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
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