DialogContainer Classe

Pacote:

com.microsoft.bot.dialogs

Artefato Maven:

com.microsoft.bot:bot-dialogs:4.14.3

• java.lang.Object
• • com.microsoft.bot.dialogs.Dialog
  • • com.microsoft.bot.dialogs.DialogContainer

public abstract class DialogContainer
extends Dialog

Um contêiner para um conjunto de caixas de diálogo.

Resumo do Construtor

Construtor	Description
DialogContainer()	Cria uma nova instância com a ID da caixa de diálogo padrão.
DialogContainer(String dialogId)	Cria uma nova instância com a ID da caixa de diálogo padrão.

Resumo do método

Modificador e tipo	Método e descrição
protected java.util.concurrent.CompletableFuture<java.lang.Void>	checkForVersionChange(DialogContext dc) Verifica se as caixas de diálogo filho de contêineres foram alteradas desde que a instância da caixa de diálogo atual foi iniciada.
abstract DialogContext	createChildContext(DialogContext dc) Cria um contexto de diálogo interno para o filho ativo dos contêineres.
Dialog	findDialog(String dialogId) Pesquisa a caixa de diálogo atualDefinir para uma caixa de diálogo por sua ID.
DialogSet	getDialogs() Retorna as caixas de diálogo como uma caixa de diálogoDefinida.
protected java.lang.String	getInternalVersion() Retorna o identificador de versão interno para esse contêiner.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	onDialogEvent(DialogContext dc, DialogEvent e) Chamado quando um evento foi gerado, usando 'Caixa de diálogoContexto.emitirEvent()', pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.
void	setTelemetryClient(BotTelemetryClient withTelemetryClient) Define o Cliente dede Telemetria do Bota ser usado para registro em log.

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

DialogContainer

public DialogContainer()

Cria uma nova instância com a ID da caixa de diálogo padrão.

DialogContainer

public DialogContainer(String dialogId)

Cria uma nova instância com a ID da caixa de diálogo padrão.

Parâmetros:

dialogId - ID da caixa de diálogo.

Detalhes do método

checkForVersionChange

protected CompletableFuture checkForVersionChange(DialogContext dc)

Verifica se as caixas de diálogo filho de contêineres foram alteradas desde que a instância da caixa de diálogo atual foi iniciada. Isso deve ser chamado no início de 'beginDialog()', 'continueDialog()' e 'resumeDialog()'.

Parâmetros:

dc - contexto da caixa de diálogo

Retornos:

CompletableFuture

createChildContext

public abstract DialogContext createChildContext(DialogContext dc)

Cria um contexto de diálogo interno para o filho ativo dos contêineres.

Parâmetros:

dc - Contexto da caixa de diálogo dos pais.

Retornos:

Um novo contexto de caixa de diálogo para o filho ativo.

findDialog

public Dialog findDialog(String dialogId)

Pesquisa o Conjunto de Diálogos atual para uma caixa de diálogo por sua ID.

Parâmetros:

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

Retornos:

A caixa de diálogo, se encontrada; caso contrário, nulo

getDialogs

public DialogSet getDialogs()

Retorna as caixas de diálogo como um Conjunto de Diálogos.

Retornos:

O Conjunto de Diálogos de Caixas de Diálogo.

getInternalVersion

protected String getInternalVersion()

Retorna o identificador de versão interno para esse contêiner.

DialogContainers detectam alterações de todos os subcompositórios no contêiner e mapeiam isso para um evento DialogChanged. Como eles fazem isso, os DialogContainers "ocultam" as alterações internas e apenas têm a .id. Isso isola as alterações no nível do contêiner, a menos que um contêiner não o manipule. Para dar suporte a esse DialogContainers, defina um método virtual protegido getInternalVersion() que calcula se essa caixa de diálogo ou caixas de diálogo filho foram alteradas, o que é então examinado por meio de chamadas para checkForVersionChange().

Retornos:

que representa a alteração dos internos desse contêiner.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

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.

Essa substituição rastreará as alterações de versão.

Substituições:

DialogContainer.onDialogEvent(DialogContext dc, DialogEvent e)

Parâmetros:

dc - O contexto da caixa de diálogo para a virada atual da conversa.

e - O evento que está sendo gerado.

Retornos:

True se o evento for tratado pela caixa de diálogo atual e o borbulhamento deve parar.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Define o BotTelemetryClient a ser usado para registro em log. Ao definir essa propriedade, todas as propriedades botTelemetryClient das caixas de diálogo contidas também são definidas.

Substituições:

DialogContainer.setTelemetryClient(BotTelemetryClient withTelemetryClient)

Parâmetros:

withTelemetryClient - O BotTelemetryClient a ser usado para registro em log.