DialogContext Classe
- java.
lang. Object - com.
microsoft. bot. dialogs. DialogContext
- com.
public class DialogContext
Fornece contexto para o estado atual da pilha de diálogos.
Resumo do Construtor
Construtor | Description |
---|---|
DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState) |
Inicializa uma nova instância da classe Contexto da Caixa de Diálogo |
DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState) |
Inicializa uma nova instância da classe Contexto da Caixa de Diálogo |
Resumo do método
Modificador e tipo | Método e descrição |
---|---|
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(String dialogId)
Inicia uma nova caixa de diálogo e a envia para a pilha de caixas de diálogo. |
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(String dialogId, Object options)
Inicia uma nova caixa de diálogo e a envia para a pilha de caixas de diálogo. |
java.util.concurrent.CompletableFuture<Dialog |
cancelAllDialogs()
O método auxiliar para cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) isso não cancela caixas de diálogo pai nem passa e evento. |
java.util.concurrent.CompletableFuture<Dialog |
cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)
Exclui qualquer pilha de diálogo existente, cancelando assim todas as caixas de diálogo na pilha. |
java.util.concurrent.CompletableFuture<Dialog |
continueDialog()
Continua a execução da caixa de diálogo ativa, se houver uma, passando o Contexto da Caixa de Diálogo |
java.util.concurrent.CompletableFuture<java.lang.Boolean> | emitEvent(String name) |
java.util.concurrent.CompletableFuture<java.lang.Boolean> | emitEvent(String name, Object value, boolean bubble, boolean fromLeaf) |
java.util.concurrent.CompletableFuture<Dialog |
endDialog()
Método auxiliar que fornece um resultado nulo para endDialog(Object result). |
java.util.concurrent.CompletableFuture<Dialog |
endDialog(Object result)
Encerra uma caixa de diálogo tirando-a da pilha e retornando um resultado opcional para o pai da caixa de diálogo. |
Dialog |
findDialog(String dialogId)
Localize a ID da caixa de diálogo para o contexto fornecido. |
Dialog |
getActiveDialog()
Obtém a instância armazenada em cache da caixa de diálogo ativa na parte superior da pilha ou nula se a pilha estiver vazia. |
Dialog |
getChild()
Obtém o contexto da caixa de diálogo para filho se houver um filho ativo. |
Turn |
getContext()
Obtém o contexto para a virada de conversa atual. |
Dialog |
getDialogs()
Obtém o conjunto de caixas de diálogo que estão ativas para o contêiner de caixa de diálogo atual. |
java.lang.String |
getLocale()
Obtenha a localidade no Contexto da Caixa de Diálogo |
Dialog |
getParent()
Obtém o contexto da caixa de diálogo |
Turn |
getServices()
Obtém a coleção de serviços que é contextual para esse contexto de caixa de diálogo. |
java.util.List<Dialog |
getStack()
Obtém a pilha de diálogo atual. |
Dialog |
getState()
Obtém ou define o Gerenciador de Estado |
java.util.concurrent.CompletableFuture<Dialog |
prompt(String dialogId, PromptOptions options)
Função auxiliar para simplificar a formatação das opções para chamar uma caixa de diálogo de prompt. |
java.util.concurrent.CompletableFuture<Dialog |
replaceDialog(String dialogId)
O método auxiliar para replaceDialog(String dialogId, Object options) isso passa nulo para opções. |
java.util.concurrent.CompletableFuture<Dialog |
replaceDialog(String dialogId, Object options)
Inicia uma nova caixa de diálogo e substitui a caixa de diálogo atualmente ativa na pilha por uma nova. |
java.util.concurrent.CompletableFuture<java.lang.Void> |
repromptDialog()
Chama o método da caixa de repromptDialog(TurnContext turnContext, DialogInstance instance) diálogo atualmente ativa. |
void |
setParent(DialogContext withDialogContext)
Defina o contexto da caixa de diálogo |
Métodos herdados de java.lang.Object
Detalhes do construtor
DialogContext
public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)
Inicializa uma nova instância da classe DialogContext do contexto de turno.
Parameters:
DialogContext
public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)
Inicializa uma nova instância da classe DialogContext do contexto de turno.
Parameters:
Detalhes do método
beginDialog
public CompletableFuture
Inicia uma nova caixa de diálogo e a envia para a pilha de caixas de diálogo.
Parameters:
Returns:
beginDialog
public CompletableFuture
Inicia uma nova caixa de diálogo e a envia para a pilha de caixas de diálogo.
Parameters:
Returns:
cancelAllDialogs
public CompletableFuture
O método auxiliar para cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) isso não cancela caixas de diálogo pai nem passa e evento.
Returns:
cancelAllDialogs
public CompletableFuture
Exclui qualquer pilha de diálogo existente, cancelando assim todas as caixas de diálogo na pilha.
Em geral, o contexto pai é o manipulador de diálogo ou de turno do bot que iniciou a caixa de diálogo. Se o pai for uma caixa de diálogo, a pilha chamará o método pai resumeDialog(DialogContext dc, DialogReason reason, Object result) para retornar um resultado para a caixa de diálogo pai. Se a caixa de diálogo pai não implementar Dialog#resumeDialog, o pai também terminará e o resultado será passado para o próximo contexto pai.
Parameters:
Returns:
continueDialog
public CompletableFuture
Continua a execução da caixa de diálogo ativa, se houver uma, passando o DialogContext atual para o método da caixa de continueDialog(DialogContext dc) diálogo ativa.
Returns:
emitEvent
public CompletableFuture
Parameters:
Returns:
emitEvent
public CompletableFuture
Parameters:
true
.
Returns:
endDialog
public CompletableFuture
Método auxiliar que fornece um resultado nulo para endDialog(Object result).
Returns:
endDialog
public CompletableFuture
Encerra uma caixa de diálogo tirando-a da pilha e retornando um resultado opcional para o pai da caixa de diálogo. A caixa de diálogo pai é a caixa de diálogo em que o iniciado está sendo encerrado por meio de uma chamada para beginDialog(String dialogId, Object options) ou prompt(String dialogId, PromptOptions options). A caixa de diálogo pai terá seu resumeDialog(DialogContext dc, DialogReason reason, Object result) método invocado com qualquer resultado retornado. Se a caixa de diálogo pai não tiver implementado um resumeDialog(DialogContext dc, DialogReason reason) método, ele também será encerrado automaticamente e o resultado será passado para seu pai. Se não houver mais caixas de diálogo pai na pilha, o processamento da curva terminará.
Parameters:
Returns:
findDialog
public Dialog findDialog(String dialogId)
Localize a ID da caixa de diálogo para o contexto fornecido.
Parameters:
Returns:
getActiveDialog
public DialogInstance getActiveDialog()
Obtém a instância armazenada em cache da caixa de diálogo ativa na parte superior da pilha ou nula se a pilha estiver vazia.
Returns:
getChild
public DialogContext getChild()
Obtém o contexto da caixa de diálogo para filho se houver um filho ativo.
Returns:
getContext
public TurnContext getContext()
Obtém o contexto para a virada de conversa atual.
Returns:
getDialogs
public DialogSet getDialogs()
Obtém o conjunto de caixas de diálogo que estão ativas para o contêiner de caixa de diálogo atual.
Returns:
getLocale
public String getLocale()
Obtenha a localidade em DialogContext.
Returns:
getParent
public DialogContext getParent()
Obtém o DialogContext pai, se houver. Usado ao pesquisar a ID de uma caixa de diálogo a ser iniciada.
Returns:
getServices
public TurnContextStateCollection getServices()
Obtém a coleção de serviços que é contextual para esse contexto de caixa de diálogo.
Returns:
getStack
public List
Obtém a pilha de diálogo atual.
Returns:
getState
public DialogStateManager getState()
Obtém ou define o DialogStateManager que gerencia a exibição de todos os escopos de memória.
Returns:
prompt
public CompletableFuture
Função auxiliar para simplificar a formatação das opções para chamar uma caixa de diálogo de prompt. Esse auxiliar pegará um argumento PromptOptions e, em seguida, chamará beginDialog(String dialogId, Object options)
Parameters:
Returns:
replaceDialog
public CompletableFuture
O método auxiliar para replaceDialog(String dialogId, Object options) isso passa nulo para opções.
Parameters:
Returns:
replaceDialog
public CompletableFuture
Inicia uma nova caixa de diálogo e substitui a caixa de diálogo atualmente ativa na pilha por uma nova. Isso é particularmente útil para criar loops ou redirecionar para outra caixa de diálogo.
Parameters:
Returns:
repromptDialog
public CompletableFuture
Chama o método da caixa de repromptDialog(TurnContext turnContext, DialogInstance instance) diálogo atualmente ativa. Usado com caixas de diálogo que implementam um comportamento de prompt novamente.
Returns:
setParent
public void setParent(DialogContext withDialogContext)
Defina o DialogContext pai.
Parameters: