DialogContext Classe

Pacote:

com.microsoft.bot.dialogs

Artefato Maven:

com.microsoft.bot:bot-dialogs:4.14.3

• java.lang.Object
• • com.microsoft.bot.dialogs.DialogContext

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 DialogContext do contexto de turno.
DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)	Inicializa uma nova instância da classe DialogContext do contexto de turno.

Resumo do método

Modificador e tipo	Método e descrição
java.util.concurrent.CompletableFuture<DialogTurnResult>	beginDialog(String dialogId) Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogo.
java.util.concurrent.CompletableFuture<DialogTurnResult>	beginDialog(String dialogId, Object options) Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogo.
java.util.concurrent.CompletableFuture<DialogTurnResult>	cancelAllDialogs() Método auxiliar para cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) que não cancelam caixas de diálogo pai ou pass e evento.
java.util.concurrent.CompletableFuture<DialogTurnResult>	cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) Exclui qualquer pilha de diálogo existente, cancelando todas as caixas de diálogo na pilha.
java.util.concurrent.CompletableFuture<DialogTurnResult>	continueDialog() Continua a execução da caixa de diálogo ativa, se houver uma, passando a caixa de diálogo atualContexto para o método continueDialog(DialogContext dc) da caixa de diálogo ativa.
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<DialogTurnResult>	endDialog() Método auxiliar que fornece um resultado nulo para endDialog(Object result).
java.util.concurrent.CompletableFuture<DialogTurnResult>	endDialog(Object result) Termina 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.
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.
DialogContext	getChild() Obtém o contexto da caixa de diálogo para filho se houver um filho ativo.
TurnContext	getContext() Obtém o contexto para a virada atual da conversa.
DialogSet	getDialogs() Obtém o conjunto de diálogos que estão ativos para o contêiner de diálogo atual.
java.lang.String	getLocale() Obtenha a localidade na caixa de diálogoContexto.
DialogContext	getParent() Obtém a caixa de diálogo paiContexto, se houver.
TurnContextStateCollection	getServices() Obtém a coleção de serviços que é contextual para esse contexto de caixa de diálogo.
java.util.List<DialogInstance>	getStack() Obtém a pilha de diálogo atual.
DialogStateManager	getState() Obtém ou define a caixa de diálogoStateManager que gerencia a exibição de todos os escopos de memória.
java.util.concurrent.CompletableFuture<DialogTurnResult>	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<DialogTurnResult>	replaceDialog(String dialogId) Método auxiliar para replaceDialog(String dialogId, Object options) que passa nulo para opções.
java.util.concurrent.CompletableFuture<DialogTurnResult>	replaceDialog(String dialogId, Object options) Inicia uma nova caixa de diálogo e substitui na pilha a caixa de diálogo atualmente ativa pela nova.
java.util.concurrent.CompletableFuture<java.lang.Void>	repromptDialog() Chama o método repromptDialog(TurnContext turnContext, DialogInstance instance) do diálogo ativo no momento.
void	setParent(DialogContext withDialogContext) Defina a caixa de diálogo paiContexto.

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

DialogContext

public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

Inicializa uma nova instância da classe DialogContext do contexto de turno.

Parâmetros:

withDialogs - O conjunto de diálogos para o qual criar o contexto da caixa de diálogo.

withTurnContext - O contexto de turno atual.

withState - A propriedade de estado da qual recuperar o contexto da caixa de diálogo.

DialogContext

public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

Inicializa uma nova instância da classe DialogContext do contexto de turno.

Parâmetros:

withDialogs - O conjunto de diálogos para o qual criar o contexto da caixa de diálogo.

withParentDialogContext - Contexto da caixa de diálogo pai.

withState - Estado da caixa de diálogo atual.

Detalhes do método

beginDialog

public CompletableFuture beginDialog(String dialogId)

Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogo.

Parâmetros:

dialogId - ID da caixa de diálogo a ser iniciada.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

beginDialog

public CompletableFuture beginDialog(String dialogId, Object options)

Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogo.

Parâmetros:

dialogId - ID da caixa de diálogo a ser iniciada.

options - Opcional, informações a serem passadas para a caixa de diálogo que está sendo iniciada.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

cancelAllDialogs

public CompletableFuture cancelAllDialogs()

Método auxiliar para cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) que não cancelam caixas de diálogo pai ou pass e evento.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará que os diálogos foram cancelados depois que a curva foi processada pela caixa de diálogo ou que a pilha já estava vazia.

cancelAllDialogs

public CompletableFuture cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

Exclui qualquer pilha de diálogo existente, cancelando todas as caixas de diálogo na pilha.

Em geral, o contexto pai é o manipulador de turnos de bot ou caixa de diálogo que iniciou a caixa de diálogo. Se o pai for uma caixa de diálogo, a pilha chamará o método resumeDialog(DialogContext dc, DialogReason reason, Object result) pai 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.

Parâmetros:

cancelParents - Se for verdadeiro, o cancelamento também ocorrerá por meio de diálogos pai.

eventName - O evento. Se for nulo, CANCEL_DIALOG será usado.

eventValue - O valor do evento. Pode ser nulo.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará que os diálogos foram cancelados depois que a curva foi processada pela caixa de diálogo ou que a pilha já estava vazia.

continueDialog

public CompletableFuture continueDialog()

Continua a execução da caixa de diálogo ativa, se houver uma, passando o DialogContext atual para o método continueDialog(DialogContext dc) do diálogo ativo.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

emitEvent

public CompletableFuture emitEvent(String name)

Parâmetros:

name - Nome do evento a ser gerado.

Retornos:

emitEvent

emitEvent

public CompletableFuture emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)

Parâmetros:

name - Nome do evento a ser gerado.

value - Valor a ser enviado junto com o evento.

bubble - Sinalizar para controlar se o evento deve ser gerado em bolhas para seu pai se não for tratado localmente. O padrão é um valor de true.

fromLeaf - Se o evento é emitido de um nó folha.

Retornos:

completedFuture

endDialog

public CompletableFuture endDialog()

Método auxiliar que fornece um resultado nulo para endDialog(Object result).

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará que a caixa de diálogo terminou depois que a curva foi processada pela caixa de diálogo.

endDialog

public CompletableFuture endDialog(Object result)

Termina 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 que começou a ser encerrada 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 método resumeDialog(DialogContext dc, DialogReason reason, Object result) invocado com qualquer resultado retornado. Se a caixa de diálogo pai não tiver implementado um método resumeDialog(DialogContext dc, DialogReason reason), 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á.

Parâmetros:

result - Opcional, resultado a ser passado para o contexto pai.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará que a caixa de diálogo terminou depois que a curva foi processada pela caixa de diálogo.

findDialog

public Dialog findDialog(String dialogId)

Localize a ID da caixa de diálogo para o contexto fornecido.

Parâmetros:

dialogId - ID da caixa de diálogo a ser encontrada.

Retornos:

caixa de diálogo com essa ID ou nulo.

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.

Retornos:

A instância armazenada em cache da caixa de diálogo ativa na parte superior da pilha ou nula se a pilha estiver vazia.

getChild

public DialogContext getChild()

Obtém o contexto da caixa de diálogo para filho se houver um filho ativo.

Retornos:

Contexto de caixa de diálogo para filho se houver um filho ativo.

getContext

public TurnContext getContext()

Obtém o contexto para a virada atual da conversa.

Retornos:

O contexto para a virada atual da conversa.

getDialogs

public DialogSet getDialogs()

Obtém o conjunto de diálogos que estão ativos para o contêiner de diálogo atual.

Retornos:

O conjunto de caixas de diálogo que estão ativas para o contêiner de diálogo atual.

getLocale

public String getLocale()

Obtenha a localidade em DialogContext.

Retornos:

Uma cadeia de caracteres que representa a localidade atual.

getParent

public DialogContext getParent()

Obtém o DialogContext pai, se houver. Usado ao pesquisar a ID de uma caixa de diálogo para iniciar.

Retornos:

O pai "DialogContext, se houver. Usado ao pesquisar a ID de uma caixa de diálogo para iniciar.

getServices

public TurnContextStateCollection getServices()

Obtém a coleção de serviços que é contextual para esse contexto de caixa de diálogo.

Retornos:

Coleção de serviços.

getStack

public List getStack()

Obtém a pilha de diálogo atual.

Retornos:

A pilha de diálogo atual.

getState

public DialogStateManager getState()

Obtém ou define o DialogStateManager que gerencia a exibição de todos os escopos de memória.

Retornos:

DialogStateManager com exibição de memória unificada de todos os escopos de memória.

prompt

public CompletableFuture 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. Esse auxiliar usará um argumento PromptOptions e chamará beginDialog(String dialogId, Object options)

Parâmetros:

dialogId - ID da caixa de diálogo de prompt a ser iniciada.

options - Informações a serem passadas para a caixa de diálogo de prompt que está sendo iniciada.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

replaceDialog

public CompletableFuture replaceDialog(String dialogId)

Método auxiliar para replaceDialog(String dialogId, Object options) que passa nulo para opções.

Parâmetros:

dialogId - ID da nova caixa de diálogo a ser iniciada.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

replaceDialog

public CompletableFuture replaceDialog(String dialogId, Object options)

Inicia uma nova caixa de diálogo e substitui na pilha a caixa de diálogo atualmente ativa pela nova. Isso é particularmente útil para criar loops ou redirecionar para outra caixa de diálogo.

Parâmetros:

dialogId - ID da nova caixa de diálogo a ser iniciada.

options - Opcional, informações a serem passadas para a caixa de diálogo que está sendo iniciada.

Retornos:

Se a tarefa for bem-sucedida, o resultado indicará se a caixa de diálogo ainda estará ativa depois que a curva tiver sido processada pela caixa de diálogo.

repromptDialog

public CompletableFuture repromptDialog()

Chama o método repromptDialog(TurnContext turnContext, DialogInstance instance) do diálogo ativo no momento. Usado com caixas de diálogo que implementam um comportamento de prompt novamente.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

setParent

public void setParent(DialogContext withDialogContext)

Defina o DialogContext pai.

Parâmetros:

withDialogContext - O DialogContext para o qual definir o pai.