Dialog Classe
- java.
lang. Object - com.
microsoft. bot. dialogs. Dialog
- com.
public abstract class Dialog
Classe base para todos os diálogos.
Resumo do campo
| Modificador e tipo | Campo e descrição |
|---|---|
|
static final
Dialog |
END_OF_TURN
Um DialogTurnResult que indica que a caixa de diálogo atual ainda está ativa e aguardando a entrada do usuário na próxima vez. |
Resumo do Construtor
| Construtor | Description |
|---|---|
| Dialog(String dialogId) |
Inicializa uma nova instância da classe Dialog. |
Resumo do método
| Modificador e tipo | Método e descrição |
|---|---|
|
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(DialogContext dc)
Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo. |
|
abstract
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(DialogContext dc, Object options)
Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo. |
|
java.util.concurrent.CompletableFuture<Dialog |
continueDialog(DialogContext dc)
Chamado quando a caixa de diálogo é _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 está terminando. |
| java.lang.String |
getId()
Obtém a ID da caixa de diálogo. |
|
Bot |
getTelemetryClient()
Obtém o BotTelemetryClient a ser usado para registro em log. |
| java.lang.String |
getVersion()
Obtém uma cadeia de caracteres exclusiva que representa a versão desta caixa de diálogo. |
|
protected static
java.util.concurrent.CompletableFuture<Dialog |
innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)
Implementação compartilhada de execução com o Gerenciador de |
| protected java.lang.String |
onComputeId()
Calcula uma ID para a caixa de diálogo. |
| java.util.concurrent.CompletableFuture<java.lang.Boolean> |
onDialogEvent(DialogContext dc, DialogEvent e)
Chamado quando um evento foi gerado, usando 'Caixa de diálogo |
| protected java.util.concurrent.CompletableFuture<java.lang.Boolean> |
onPostBubbleEvent(DialogContext dc, DialogEvent e)
Chamado depois que um evento foi bolhado para todos os pais e não foi tratado. |
| protected java.util.concurrent.CompletableFuture<java.lang.Boolean> |
onPreBubbleEvent(DialogContext dc, DialogEvent e)
Chamado antes de um evento ser colocado em bolhas para seu pai. |
| java.util.concurrent.CompletableFuture<java.lang.Void> |
repromptDialog(TurnContext turnContext, DialogInstance instance)
Chamado quando a caixa de diálogo deve solicitar novamente entrada ao usuário. |
|
java.util.concurrent.CompletableFuture<Dialog |
resumeDialog(DialogContext dc, DialogReason reason)
Chamado quando uma caixa de diálogo filho concluiu essa curva, retornando o controle para essa caixa de diálogo. |
|
java.util.concurrent.CompletableFuture<Dialog |
resumeDialog(DialogContext dc, DialogReason reason, Object result)
Chamado quando uma caixa de diálogo filho concluiu essa curva, retornando o controle para essa caixa de diálogo. |
| static java.util.concurrent.CompletableFuture<java.lang.Void> |
run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor)
Cria uma pilha de diálogos e inicia uma caixa de diálogo, empurrando-a para a pilha. |
| void |
setId(String withId)
Define a ID da caixa de diálogo. |
| void |
setTelemetryClient(BotTelemetryClient withTelemetryClient)
Define o BotTelemetryClient a ser usado para registro em log. |
Métodos herdados de java.lang.Object
Detalhes do campo
END_OF_TURN
public static final DialogTurnResult END_OF_TURN
Um DialogTurnResult que indica que a caixa de diálogo atual ainda está ativa e aguardando a entrada do usuário na próxima vez.
Detalhes do construtor
Dialog
public Dialog(String dialogId)
Inicializa uma nova instância da classe Dialog.
Parâmetros:
Detalhes do método
beginDialog
public CompletableFuture
Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.
Parâmetros:
Retornos:
beginDialog
public abstract CompletableFuture
Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.
Parâmetros:
Retornos:
continueDialog
public CompletableFuture
Chamado quando a caixa de diálogo é _continued_, onde é a caixa de diálogo ativa e o usuário responde com uma nova atividade.
Se esse método for *not* substituído, a caixa de diálogo terminará automaticamente quando o usuário responder.
Parâmetros:
Retornos:
endDialog
public CompletableFuture
Chamado quando a caixa de diálogo está terminando.
Parâmetros:
Retornos:
getId
public String getId()
Obtém a ID da caixa de diálogo.
Retornos:
getTelemetryClient
public BotTelemetryClient getTelemetryClient()
Obtém o BotTelemetryClient a ser usado para registro em log.
Retornos:
getVersion
public String getVersion()
Obtém uma cadeia de caracteres exclusiva que representa a versão desta caixa de diálogo. Se a versão for alterada entre as transformações, o sistema de diálogo emitirá um evento DialogChanged.
Retornos:
innerRun
protected static CompletableFuture
Implementação compartilhada de execução com Dialog e DialogManager.
Parâmetros:
Retornos:
onComputeId
protected String onComputeId()
Calcula uma ID para a caixa de diálogo.
Retornos:
onDialogEvent
public CompletableFuture
Chamado quando um evento foi gerado, usando 'DialogContext.emitEvent()', pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.
Parâmetros:
Retornos:
onPostBubbleEvent
protected CompletableFuture
Chamado depois que um evento foi bolhado para todos os pais e não foi tratado.
Esse é um bom lugar para executar a lógica de processamento padrão para um evento. Retornar 'true' impedirá qualquer processamento do evento por caixas de diálogo filho.
Parâmetros:
Retornos:
onPreBubbleEvent
protected CompletableFuture
Chamado antes de um evento ser colocado em bolhas para seu pai.
Este é um bom lugar para realizar a interceptação de um evento, pois retornar "true" impedirá qualquer propagação adicional do evento para os pais dos diálogos e também impedirá que os diálogos filho realizem seu processamento padrão.
Parâmetros:
Retornos:
repromptDialog
public CompletableFuture
Chamado quando a caixa de diálogo deve solicitar novamente entrada ao usuário.
Parâmetros:
Retornos:
resumeDialog
public CompletableFuture
Chamado quando uma caixa de diálogo filho concluiu essa curva, retornando o controle para essa caixa de diálogo.
Geralmente, a caixa de diálogo filho foi iniciada com uma chamada para beginDialog(DialogContext dc, Object options) No entanto, se o método replaceDialog(String dialogId) for chamado, a caixa de diálogo filho lógica poderá ser diferente da original.
Se esse método for *not* substituído, a caixa de diálogo terminará automaticamente quando o usuário responder.
Parâmetros:
Retornos:
resumeDialog
public CompletableFuture
Chamado quando uma caixa de diálogo filho concluiu essa curva, retornando o controle para essa caixa de diálogo.
Geralmente, a caixa de diálogo filho foi iniciada com uma chamada para beginDialog(DialogContext dc, Object options) No entanto, se o método replaceDialog(String dialogId, Object options) for chamado, a caixa de diálogo filho lógica poderá ser diferente da original.
Se esse método for *not* substituído, a caixa de diálogo terminará automaticamente quando o usuário responder.
Parâmetros:
Retornos:
run
public static CompletableFuture
Cria uma pilha de diálogos e inicia uma caixa de diálogo, empurrando-a para a pilha.
Parâmetros:
Retornos:
setId
public void setId(String withId)
Define a ID da caixa de diálogo.
Parâmetros:
setTelemetryClient
public void setTelemetryClient(BotTelemetryClient withTelemetryClient)
Define o BotTelemetryClient a ser usado para registro em log.
Parâmetros: