SkillDialog Classe

  • Referência
Pacote:
com.microsoft.bot.dialogs
Artefato Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class SkillDialog
extends Dialog

Um Dialog especializado que pode encapsular chamadas remotas para uma habilidade. O parâmetro de opções no BeginDialog deve ser um BeginSkillDialogOptions instâncias com os parâmetros iniciais da caixa de diálogo.

Resumo do Construtor

Construtor Description
SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Inicializa uma nova instância da classe SkillDialog para encapsular chamadas remotas em uma habilidade.

Resumo do método

Modificador e tipo Método e descrição
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Chamado quando a caixa de diálogo de habilidade é iniciada e enviada por push para a pilha de diálogo.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Chamado quando a caixa de diálogo de habilidade é _continued_, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Chamado quando a caixa de diálogo de habilidade está terminando.
protected SkillDialogOptions getDialogOptions()

Obtém as opções usadas para executar a caixa de diálogo de habilidade.
protected boolean onValidateActivity(Activity activity)

Valida a atividade enviada durante a caixa de diálogo Continuar.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Chamado quando a caixa de diálogo de habilidade deve solicitar novamente entrada ao usuário.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Chamado quando uma caixa de diálogo de habilidade filho completou sua vez, retornando o controle para essa caixa de diálogo.

Métodos herdados de Dialog

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

Métodos herdados 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

Detalhes do construtor

SkillDialog

public SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Inicializa uma nova instância da classe SkillDialog para encapsular chamadas remotas em uma habilidade.

Parâmetros:

dialogOptions - As opções para executar a caixa de diálogo de habilidade.
dialogId - A ID da caixa de diálogo.

Detalhes do método

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Chamado quando a caixa de diálogo de habilidade é iniciada e enviada por push para a pilha de diálogo.

Substituições:

SkillDialog.beginDialog(DialogContext dc, Object options)

Parâmetros:

dc - O DialogContext para a virada atual da conversa.
options - Informações iniciais opcionais a serem passadas para a caixa de diálogo.

Retornos:

Um CompletableFuture que representa a operação assíncrona. 
     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)

Chamado quando a caixa de diálogo de habilidade é _continued_, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.

Substituições:

SkillDialog.continueDialog(DialogContext dc)

Parâmetros:

dc - O DialogContext para a virada atual da conversa.

Retornos:

Um CompletableFuture que representa a operação assíncrona. 
     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)

Chamado quando a caixa de diálogo de habilidade está terminando.

Substituições:

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

Parâmetros:

turnContext - O objeto de contexto para este turno.
instance - Informações de estado associadas à instância dessa caixa de diálogo na pilha de diálogo.
reason - Motivo pelo qual a caixa de diálogo terminou.

Retornos:

Um CompletableFuture que representa a operação assíncrona.

getDialogOptions

protected SkillDialogOptions getDialogOptions()

Obtém as opções usadas para executar a caixa de diálogo de habilidade.

Retornos:

o valor dialogOptions como skillDialogOptions.

onValidateActivity

protected boolean onValidateActivity(Activity activity)

Valida a atividade enviada durante o ContinueDialog.

Parâmetros:

activity - O Activity para a virada atual da conversa. 
             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.

Retornos:

true se a atividade for válida, false se não for.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Chamado quando a caixa de diálogo de habilidade deve solicitar novamente entrada ao usuário.

Substituições:

SkillDialog.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parâmetros:

turnContext - O objeto de contexto para este turno.
instance - Informações de estado para esta caixa de diálogo.

Retornos:

Um CompletableFuture que representa a operação assíncrona.

resumeDialog

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

Chamado quando uma caixa de diálogo de habilidade filho completou sua vez, retornando o controle para essa caixa de diálogo.

Substituições:

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

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.
reason - Motivo pelo qual a caixa de diálogo foi retomada.
result - Opcional, o valor retornado da caixa de diálogo que foi chamada. O tipo do valor retornado depende da caixa de diálogo filho.

Retornos:

Um CompletableFuture que representa a operação assíncrona.

Aplica-se a