BeginSkill class
Comience una aptitud.
- Extends
-
SkillDialog
Constructores
| Begin |
Crea una nueva instancia de "BeginSkillDialog". |
Propiedades
| $kind | |
| activity | Plantilla para la actividad. |
| activity |
Valor que indica si el nuevo cuadro de diálogo debe procesar la actividad. |
| allow |
Directiva de interrupción. |
| bot |
Identificador de aplicación de Microsoft que llamará a la aptitud. |
| connection |
Opcional. Nombre de conexión de OAuth para el bot primario. |
| disabled | Expresión opcional que, si es true, deshabilitará esta acción. |
| result |
Ruta de acceso de propiedad opcional para almacenar el resultado del cuadro de diálogo. |
| skill |
Identificador de aplicación de Microsoft para la aptitud. |
| skill |
Punto de conexión de |
| skill |
Dirección URL de devolución de llamada para el host de aptitudes. |
Propiedades heredadas
| End |
Obtiene un resultado predeterminado de fin de turno. |
| id | |
| telemetry |
Métodos
| begin |
Se llama cuando se inicia el cuadro de diálogo de y se inserta en la pila de diálogos. |
| 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 |
|
| get |
|
| reprompt |
Se llama cuando el cuadro de diálogo de debe volver a solicitar al usuario la entrada. |
| resume |
Se llama cuando un cuadro de diálogo secundario completó su turno, devolviendo el control a este cuadro de diálogo. |
Métodos heredados
| configure(Record<string, unknown>) | Método Fluent para configurar el objeto. |
| 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
BeginSkill(SkillDialogOptions)
Crea una nueva instancia de "BeginSkillDialog".
new BeginSkill(options?: SkillDialogOptions)
Parámetros
- options
-
SkillDialogOptions
Opciones opcionales que se usan para configurar el cuadro de diálogo de aptitud.
Detalles de las propiedades
$kind
static $kind: string
Valor de propiedad
string
activity
Plantilla para la actividad.
activity: TemplateInterface<Partial<Activity>, DialogStateManager>
Valor de propiedad
TemplateInterface<Partial<Activity>, DialogStateManager>
activityProcessed
Valor que indica si el nuevo cuadro de diálogo debe procesar la actividad.
activityProcessed: BoolExpression
Valor de propiedad
BoolExpression
Comentarios
El valor predeterminado para esto será true, lo que significa que el nuevo cuadro de diálogo no debe examinar la actividad. Puede establecerlo en false para enviar la actividad al cuadro de diálogo nuevo.
allowInterruptions
Directiva de interrupción.
allowInterruptions: BoolExpression
Valor de propiedad
BoolExpression
botId
Identificador de aplicación de Microsoft que llamará a la aptitud.
botId: StringExpression
Valor de propiedad
StringExpression
Comentarios
Defauls a un valor de =settings.MicrosoftAppId que recupera el identificador de bots de la configuración.
connectionName
Opcional. Nombre de conexión de OAuth para el bot primario.
connectionName: StringExpression
Valor de propiedad
StringExpression
disabled
Expresión opcional que, si es true, deshabilitará esta acción.
disabled?: BoolExpression
Valor de propiedad
BoolExpression
resultProperty
Ruta de acceso de propiedad opcional para almacenar el resultado del cuadro de diálogo.
resultProperty?: StringExpression
Valor de propiedad
StringExpression
skillAppId
Identificador de aplicación de Microsoft para la aptitud.
skillAppId: StringExpression
Valor de propiedad
StringExpression
skillEndpoint
Punto de conexión de /api/messages para la aptitud.
skillEndpoint: StringExpression
Valor de propiedad
StringExpression
skillHostEndpoint
Dirección URL de devolución de llamada para el host de aptitudes.
skillHostEndpoint: StringExpression
Valor de propiedad
StringExpression
Comentarios
Defauls a un valor de =settings.SkillHostEndpoint que recupera el punto de conexión de la configuración.
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 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, BeginSkillDialogOptions)
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?: BeginSkillDialogOptions): Promise<DialogTurnResult>
Parámetros
- dc
-
DialogContext
dialogContext para el turno actual de conversación.
- options
-
BeginSkillDialogOptions
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.
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.
endDialog(TurnContext, DialogInstance, DialogReason)
Se llama cuando finaliza el cuadro de diálogo de .
function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>
Parámetros
- turnContext
-
TurnContext
(xref:botbuilder-core. TurnContext), el objeto de contexto de este turno.
- instance
-
DialogInstance
(xref:botbuilder-dialogs. DialogInstance), información de estado asociada a la instancia de este diálogo en la pila de diálogos.
- reason
-
DialogReason
(xref:botbuilder-dialogs. DialogReason), motivo por el que finalizó el diálogo.
Devoluciones
Promise<void>
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.
repromptDialog(TurnContext, DialogInstance)
Se llama cuando el cuadro de diálogo de debe volver a solicitar al usuario la entrada.
function repromptDialog(turnContext: TurnContext, instance: DialogInstance): Promise<void>
Parámetros
- turnContext
-
TurnContext
(xref:botbuilder-core. TurnContext), el objeto de contexto de este turno.
- instance
-
DialogInstance
(xref:botbuilder-dialogs. DialogInstance), información de estado de este cuadro de diálogo.
Devoluciones
Promise<void>
Un Promise que representa la operación asincrónica.
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<any>>
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<any>>
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>): 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
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