DynamicBeginDialog class

Pacote:

botbuilder-dialogs-adaptive

Ação de BeginDialog interna que associa dinamicamente x.schema/x.dialog para invocar o recurso x.dialog com propriedades como as opções.

Extends

BeginDialog

Construtores

DynamicBeginDialog(string, O)

Cria uma nova instância de BeginDialog.

Propriedades

$kind

Propriedades herdadas

activityProcessed	Um valor que indica se a nova caixa de diálogo deve processar a atividade.
dialog	A caixa de diálogo a ser chamada.
disabled	Uma expressão opcional que, se for true, desabilitará essa ação.
EndOfTurn	Obtém um resultado de fim de turno padrão.
id
options	Opções configuráveis para a caixa de diálogo.
resultProperty	(Opcional) caminho de propriedade para armazenar o resultado da caixa de diálogo.
telemetryClient

Métodos herdados

beginDialog(DialogContext, O)	Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogos.
configure(Record<string, unknown>)	Método fluente para configurar o objeto.
continueDialog(DialogContext)	Quando substituído em uma classe derivada, continua a caixa de diálogo.
endDialog(TurnContext, DialogInstance, DialogReason)	Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.
getConverter(Object)
getDependencies()	Obtém a caixa de diálogo filho dependências para que elas possam ser adicionadas aos contêineres conjunto de de diálogo.
getVersion()	Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.
onDialogEvent(DialogContext, DialogEvent)	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.
repromptDialog(TurnContext, DialogInstance)	Quando substituído em uma classe derivada, reprompta o usuário para entrada.
resumeDialog(DialogContext, DialogReason, any)	Chamado quando uma caixa de diálogo filho concluído sua vez, retornando o controle para essa caixa de diálogo.

Detalhes do construtor

DynamicBeginDialog(string, O)

Cria uma nova instância de BeginDialog.

new DynamicBeginDialog(dialogIdToCall: string, options?: O)

Parâmetros

dialogIdToCall

string

ID da caixa de diálogo a ser chamada.

options

O

Opções estáticas (opcionais) para passar a caixa de diálogo chamada.

Detalhes da propriedade

$kind

static $kind: string

Valor da propriedade

string

Detalhes das propriedades herdadas

activityProcessed

Um valor que indica se a nova caixa de diálogo deve processar a atividade.

activityProcessed: BoolExpression

Valor da propriedade

BoolExpression

Herdado deBaseInvokeDialog.activityProcessed

dialog

A caixa de diálogo a ser chamada.

dialog: DialogExpression

Valor da propriedade

DialogExpression

herdado deBaseInvokeDialog.dialog

disabled

Uma expressão opcional que, se for true, desabilitará essa ação.

disabled?: BoolExpression

Valor da propriedade

BoolExpression

herdado deBeginDialog.disabled

EndOfTurn

Obtém um resultado de fim de turno padrão.

static EndOfTurn: DialogTurnResult

Valor da propriedade

DialogTurnResult

Comentários

Esse resultado indica que uma caixa de diálogo (ou uma etapa lógica em uma caixa de diálogo) concluiu o processamento para a curva atual, ainda está ativa e está aguardando mais entrada.

herdado de dialog.EndOfTurn

id

id: string

Valor da propriedade

string

herdado de Dialog.id

options

Opções configuráveis para a caixa de diálogo.

options: ObjectExpression<object>

Valor da propriedade

ObjectExpression<object>

herdado deBaseInvokeDialog.options

resultProperty

(Opcional) caminho de propriedade para armazenar o resultado da caixa de diálogo.

resultProperty?: StringExpression

Valor da propriedade

StringExpression

Herdado deBeginDialog.resultProperty

telemetryClient

telemetryClient: BotTelemetryClient

Valor da propriedade

BotTelemetryClient

Herdado de Dialog.telemetryClient

Detalhes do método herdado

beginDialog(DialogContext, O)

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

function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

options

O

Opcional. Informações iniciais a serem passadas para a caixa de diálogo.

Retornos

Promise<DialogTurnResult>

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

Herdado deBeginDialog.beginDialog

configure(Record<string, unknown>)

Método fluente para configurar o objeto.

function configure(config: Record<string, unknown>): this

Parâmetros

config

Record<string, unknown>

Configurações a serem aplicadas.

Retornos

this

O configurável após a conclusão da operação.

Herdado de Configurble.configure

continueDialog(DialogContext)

Quando substituído em uma classe derivada, continua a caixa de diálogo.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O contexto da curva de diálogo atual.

Retornos

Promise<DialogTurnResult>

Uma promessa de resolução para o resultado da curva da caixa de diálogo.

Comentários

Caixas de diálogo derivadas que dão suporte a conversas de várias voltas devem substituir esse método. Por padrão, esse método sinaliza que a caixa de diálogo está concluída e retorna.

O DialogContext chama esse método quando ele continua a caixa de diálogo.

Para sinalizar para o contexto da caixa de diálogo que essa caixa de diálogo foi concluída, aguarde DialogContext.endDialog antes de sair desse método.

Consulte também

• DialogContext.continueDialog

Herdado de Dialog.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parâmetros

_context

TurnContext

O objeto de contexto para a curva.

_instance

DialogInstance

Informações de estado atuais para essa caixa de diálogo.

_reason

DialogReason

O motivo pelo qual a caixa de diálogo está terminando.

Retornos

Promise<void>

Comentários

As caixas de diálogo derivadas que precisam executar o registro em log ou a limpeza antes de terminar devem substituir esse método. Por padrão, esse método não tem efeito.

O dialogContext chama esse método quando a caixa de diálogo atual está terminando.

Consulte também

• DialogContext.cancelAllDialogs
• dialogContext.endDialog
• DialogContext.replaceDialog

Herdado de Dialog.endDialog

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parâmetros

property

Object

A chave da configuração do seletor condicional.

Retornos

Converter | ConverterFactory

O conversor para a configuração do seletor.

Herdado deBeginDialog.getConverter

getDependencies()

Obtém a caixa de diálogo filho dependências para que elas possam ser adicionadas aos contêineres conjunto de de diálogo.

function getDependencies(): Dialog<__type>[]

Retornos

Dialog<__type>[]

A caixa de diálogo filho dependências.

Herdado deBaseInvokeDialog.getDependencies

getVersion()

Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.

function getVersion(): string

Retornos

string

Cadeia de caracteres exclusiva que só deve ser alterada quando a caixa de diálogo foi alterada de uma maneira que deve reiniciar a caixa de diálogo.

Comentários

Esse padrão é retornar as caixas de diálogo id mas pode ser substituído para fornecer uma lógica de detecção de alterações mais precisa. Qualquer caixa de diálogo na pilha que tenha sua alteração de versão resultará em um evento versionChanged será gerado. Se esse evento não for tratado pelo bot, um erro será gerado, resultando na execução da lógica do manipulador de erros de bots.

Retornar uma cadeia de caracteres vazia desabilitará o acompanhamento de versão para o componente.

Herdado de Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

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.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parâmetros

dc

DialogContext

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

e

DialogEvent

O evento que está sendo gerado.

Retornos

Promise<boolean>

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

herdado da caixa de diálogo.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Quando substituído em uma classe derivada, reprompta o usuário para entrada.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parâmetros

_context

TurnContext

O objeto de contexto para a curva.

_instance

DialogInstance

Informações de estado atuais para essa caixa de diálogo.

Retornos

Promise<void>

Comentários

Caixas de diálogo derivadas que dão suporte à validação e à lógica de nova solicitação devem substituir esse método. Por padrão, esse método não tem efeito.

O DialogContext chama esse método quando a caixa de diálogo atual deve solicitar novamente a entrada do usuário. Esse método é implementado para caixas de diálogo de prompt.

Consulte também

• DialogContext.repromptDialog
• prompt

Herdado de Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Chamado quando uma caixa de diálogo filho concluído sua vez, retornando o controle para essa caixa de diálogo.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), motivo pelo qual a caixa de diálogo foi retomada.

result

any

Opcional. Valor retornado da caixa de diálogo que foi chamada. O tipo do valor retornado depende da caixa de diálogo filho.

Retornos

Promise<DialogTurnResult>

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

Herdado deBeginDialog.resumeDialog