ForEach class

Pacote:

botbuilder-dialogs-adaptive

Executa um conjunto de ações uma vez para cada item em uma lista ou coleção na memória.

Extends

ActionScope<O>

Construtores

ForEach()	Inicializa uma nova instância da classe foreach .
ForEach(string, Dialog[])	Inicializa uma nova instância da classe foreach .

Propriedades

$kind
disabled	Uma expressão opcional que, se for true, desabilitará essa ação.
index	Expressão de caminho de propriedade para o índice de item.
itemsProperty	Expressão de caminho de propriedade para a coleção de itens.
value	Expressão de caminho de propriedade para o valor do item.

Propriedades herdadas

actions	As ações a serem executadas.
EndOfTurn	Obtém um resultado de fim de turno padrão.
id
telemetryClient

Métodos

beginDialog(DialogContext, O)	Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogos.
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.

Métodos herdados

configure(Record<string, unknown>)	Método fluente para configurar o objeto.
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.
endDialog(TurnContext, DialogInstance, DialogReason)	Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.
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.
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

ForEach()

Inicializa uma nova instância da classe foreach .

new ForEach()

ForEach(string, Dialog[])

Inicializa uma nova instância da classe foreach .

new ForEach(itemsProperty: string, actions: Dialog[])

Parâmetros

itemsProperty

string

Expressão de caminho de propriedade para a coleção de itens.

actions

Dialog[]

As ações a serem executadas.

Detalhes da propriedade

$kind

static $kind: string

Valor da propriedade

string

disabled

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

disabled?: BoolExpression

Valor da propriedade

BoolExpression

index

Expressão de caminho de propriedade para o índice de item.

index: StringExpression

Valor da propriedade

StringExpression

itemsProperty

Expressão de caminho de propriedade para a coleção de itens.

itemsProperty: StringExpression

Valor da propriedade

StringExpression

value

Expressão de caminho de propriedade para o valor do item.

value: StringExpression

Valor da propriedade

StringExpression

Detalhes das propriedades herdadas

actions

As ações a serem executadas.

actions: Dialog[]

Valor da propriedade

Dialog[]

herdado doActionScope.actions

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)

Inicia uma nova caixa de diálogo e a envia 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.

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.

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

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 para a virada atual da conversa.

Retornos

Promise<DialogTurnResult>

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

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

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.

herdado doActionScope.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 doActionScope.resumeDialog