Compartilhar via

CancelAllDialogs class

  • Referência
Pacote:
botbuilder-dialogs-adaptive

Comando para cancelar todas as caixas de diálogo atuais emitindo um evento que deve ser capturado para impedir a propagação do cancelamento.

Extends

CancelAllDialogsBase<O>

Construtores

CancelAllDialogs()

Inicializa uma nova instância da classe CancelAllDialogs.
CancelAllDialogs(string, string)

Inicializa uma nova instância da classe CancelAllDialogs.

Propriedades

$kind

Propriedades herdadas

activityProcessed

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

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

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

Expressão para o nome do evento.
eventValue

Expressão para o valor do evento.
id
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)
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)

Quando substituído em uma classe derivada, retoma a caixa de diálogo após a caixa de diálogo acima dela na pilha ser concluída.

Detalhes do construtor

CancelAllDialogs()

Inicializa uma nova instância da classe CancelAllDialogs.

new CancelAllDialogs()

CancelAllDialogs(string, string)

Inicializa uma nova instância da classe CancelAllDialogs.

new CancelAllDialogs(eventName: string, eventValue?: string)

Parâmetros

eventName

string

Expressão para o nome do evento.

eventValue

string

Opcional. Expressão para o valor do evento.

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 deCancelAllDialogsBase.activityProcessed

disabled

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

disabled: BoolExpression

Valor da propriedade

BoolExpression

herdado deCancelAllDialogsBase.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

eventName

Expressão para o nome do evento.

eventName: StringExpression

Valor da propriedade

StringExpression

Herdado deCancelAllDialogsBase.eventName

eventValue

Expressão para o valor do evento.

eventValue: ValueExpression

Valor da propriedade

ValueExpression

Herdado deCancelAllDialogsBase.eventValue

id 

id: string

Valor da propriedade

string

herdado de Dialog.id

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 doCancelAllDialogsBase.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

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

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 deCancelAllDialogsBase.getConverter

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

Herdado de Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Quando substituído em uma classe derivada, retoma a caixa de diálogo após a caixa de diálogo acima dela na pilha ser concluída.

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

Parâmetros

dc

DialogContext

O contexto da curva de diálogo atual.

reason

DialogReason

O motivo pelo qual a caixa de diálogo está sendo retomada. Normalmente, isso será dialogReason.endCalled

result

any

Opcional. O valor retornado, se houver, da caixa de diálogo que terminou.

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 retoma a caixa de diálogo. Se a caixa de diálogo anterior na pilha retornar um valor, esse valor estará no parâmetro result.

Para iniciar uma caixa de diálogo filho , use DialogContext.beginDialog ou DialogContext.prompt; no entanto, essa caixa de diálogo não será necessariamente a que iniciou a caixa de diálogo filho. 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

Herdado de Dialog.resumeDialog