SkillDialog Clase

  • Referencia
Paquete:
com.microsoft.bot.dialogs
Artefacto Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class SkillDialog
extends Dialog

Un Dialog especializado que puede encapsular llamadas remotas a una aptitud. El parámetro options de BeginDialog debe ser una instancia de BeginSkillDialogOptions con los parámetros iniciales del cuadro de diálogo.

Resumen del constructor

Constructor Description
SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Inicializa una nueva instancia de la clase SkillDialog para encapsular llamadas remotas a una aptitud.

Resumen del método

Modificador y tipo Método y descripción
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Se llama cuando se inicia y se inserta el cuadro de diálogo de aptitud en la pila de diálogos.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Se llama cuando el cuadro de diálogo de aptitud es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Se llama cuando finaliza el cuadro de diálogo de aptitud.
protected SkillDialogOptions getDialogOptions()

Obtiene las opciones usadas para ejecutar el cuadro de diálogo de aptitud.
protected boolean onValidateActivity(Activity activity)

Valida la actividad enviada durante continueDialog .
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando el cuadro de diálogo de aptitud debe volver a solicitar al usuario la entrada.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

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 de Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Métodos heredados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalles del constructor

SkillDialog

public SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Inicializa una nueva instancia de la clase SkillDialog para encapsular llamadas remotas a una aptitud.

Parámetros:

dialogOptions - Las opciones para ejecutar el cuadro de diálogo de aptitud.
dialogId - Identificador del cuadro de diálogo.

Detalles del método

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Se llama cuando se inicia y se inserta el cuadro de diálogo de aptitud en la pila de diálogos.

Invalidaciones:

SkillDialog.beginDialog(DialogContext dc, Object options)

Parámetros:

dc - El DialogContext para el turno actual de conversación.
options - Opcional, información inicial que se va a pasar al cuadro de diálogo.

Devoluciones:

Un CompletableFuture que representa la operación asincrónica. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Se llama cuando el cuadro de diálogo de aptitud es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad.

Invalidaciones:

SkillDialog.continueDialog(DialogContext dc)

Parámetros:

dc - El DialogContext para el turno actual de conversación.

Devoluciones:

Un CompletableFuture que representa la operación asincrónica. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Se llama cuando finaliza el cuadro de diálogo de aptitud.

Invalidaciones:

SkillDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Parámetros:

turnContext - Objeto de contexto para este turno.
instance - Información de estado asociada a la instancia de este cuadro de diálogo en la pila de diálogos.
reason - Motivo por el que finalizó el cuadro de diálogo.

Devoluciones:

Un CompletableFuture que representa la operación asincrónica.

getDialogOptions

protected SkillDialogOptions getDialogOptions()

Obtiene las opciones usadas para ejecutar el cuadro de diálogo de aptitud.

Devoluciones:

El valor DialogOptions como skillDialogOptions.

onValidateActivity

protected boolean onValidateActivity(Activity activity)

Valida la actividad enviada durante ContinueDialog .

Parámetros:

activity - El Activity para el turno actual de conversación. 
             Override this method to implement a custom validator for the
             activity being sent during the ContinueDialog . This
             method can be used to ignore activities of a certain type if
             needed. If this method returns false, the dialog will end the
             turn without processing the activity.

Devoluciones:

True si la actividad es válida, false si no.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando el cuadro de diálogo de aptitud debe volver a solicitar al usuario la entrada.

Invalidaciones:

SkillDialog.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parámetros:

turnContext - Objeto de contexto para este turno.
instance - Información de estado de este cuadro de diálogo.

Devoluciones:

Un CompletableFuture que representa la operación asincrónica.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

Se llama cuando un cuadro de diálogo de aptitud secundaria ha completado su turno y devuelve el control a este diálogo.

Invalidaciones:

SkillDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

Parámetros:

dc - Contexto del cuadro de diálogo para el turno actual de la conversación.
reason - Motivo por el que se reanudó el cuadro de diálogo.
result - 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:

Un CompletableFuture que representa la operación asincrónica.

Se aplica a