ActionScope class
ActionScope gerencia a execução de um bloco de ações e dá suporte à semântica Goto, Continue e Break.
- Extends
-
Dialog<O>
Construtores
| Action |
Cria uma nova instância de |
Propriedades
| actions | As ações a serem executadas. |
Propriedades herdadas
| End |
Obtém um resultado de fim de turno padrão. |
| id | |
| telemetry |
Métodos
| begin |
Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogos. |
| continue |
Chamado quando a caixa de diálogo é continua, em que é a caixa de diálogo ativa e o usuário responde com uma nova atividade. |
| get |
|
| get |
Obtém a caixa de diálogo filho dependências para que elas possam ser adicionadas aos contêineres conjunto de de diálogo. |
| get |
Obtém uma |
| resume |
Chamado quando uma caixa de diálogo filho concluído sua vez, retornando o controle para essa caixa de diálogo. |
Métodos herdados
| configure(Record<string, unknown>) | Método fluente para configurar o objeto. |
| end |
Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar. |
| on |
Chamado quando um evento foi gerado, usando |
| reprompt |
Quando substituído em uma classe derivada, reprompta o usuário para entrada. |
Detalhes do construtor
ActionScope(Dialog[])
Cria uma nova instância de ActionScope.
new ActionScope(actions?: Dialog[])
Parâmetros
- actions
-
Dialog[]
As ações para o escopo.
Detalhes da propriedade
actions
As ações a serem executadas.
actions: Dialog[]
Valor da propriedade
Dialog[]
Detalhes das propriedades herdadas
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
telemetryClient
telemetryClient: BotTelemetryClient
Valor da propriedade
BotTelemetryClient
Herdado de Dialog.telemetryClient
Detalhes do método
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
- _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.
continueDialog(DialogContext)
Chamado quando a caixa de diálogo é continua, em que é a caixa de diálogo ativa e o usuário responde com uma nova atividade.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>
Parâmetros
- dc
-
DialogContext
O dialogContext
Retornos
Promise<DialogTurnResult>
Um Promise que representa a operação assíncrona.
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.
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[]
Retornos
Dialog[]
A caixa de diálogo filho dependências.
getVersion()
Obtém uma string exclusiva que representa a versão desta caixa de diálogo. Se a versão for alterada entre as transformações, o sistema de diálogo emitirá um evento DialogChanged.
function getVersion(): string
Retornos
string
string exclusivo que só deve ser alterado quando a caixa de diálogo for alterada de uma maneira que deve reiniciar a caixa de diálogo.
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
- _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.
Detalhes do método herdado
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
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
Consulte também
- DialogContext.cancelAllDialogs
- dialogContext.endDialog
-
DialogContext.replaceDialog
Herdado de Dialog.endDialog
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
Consulte também
Herdado de Dialog.repromptDialog