ForEach class

Pacchetto:

botbuilder-dialogs-adaptive

Esegue un set di azioni una volta per ogni elemento in un elenco o una raccolta in memoria.

Extends

ActionScope<O>

Costruttori

ForEach()	Inizializza una nuova istanza della classe Foreach .
ForEach(string, Dialog[])	Inizializza una nuova istanza della classe Foreach .

Proprietà

$kind
disabled	Espressione facoltativa che, se è true, disabiliterà questa azione.
index	Espressione del percorso della proprietà per l'indice dell'elemento.
itemsProperty	Espressione del percorso della proprietà per l'insieme di elementi.
value	Espressione del percorso della proprietà al valore dell'elemento.

Proprietà ereditate

actions	Azioni da eseguire.
EndOfTurn	Ottiene un risultato di fine turno predefinito.
id
telemetryClient

Metodi

beginDialog(DialogContext, O)	Avvia un nuovo dialog e lo inserisce nello stack di dialoghi.
getConverter(Object)
getDependencies()	Ottiene le dipendenze finestra di dialogo figlio in modo che possano essere aggiunte ai contenitori finestra di dialogo.

Metodi ereditati

configure(Record<string, unknown>)	Metodo Fluent per la configurazione dell'oggetto.
continueDialog(DialogContext)	Chiamato quando la finestra di dialogo continua continua, dove è il dialogo attivo e l'utente risponde con una nuova attività.
endDialog(TurnContext, DialogInstance, DialogReason)	Quando sottoposto a override in una classe derivata, esegue la pulizia per la finestra di dialogo prima che termini.
getVersion()	Ottiene un string univoco che rappresenta la versione di questa finestra di dialogo. Se la versione cambia tra turni il sistema del dialogo genererà un evento DialogChanged.
onDialogEvent(DialogContext, DialogEvent)	Chiamato quando è stato generato un evento, utilizzando DialogContext.emitEvent(), dalla finestra di dialogo corrente o da una finestra di dialogo avviata dalla finestra di dialogo corrente.
repromptDialog(TurnContext, DialogInstance)	Quando ne viene eseguito l'override in una classe derivata, reinserito l'utente per l'input.
resumeDialog(DialogContext, DialogReason, any)	Chiamato quando un dialogo figlio completato il suo turno, restituendo il controllo a questa finestra di dialogo.

Dettagli costruttore

ForEach()

Inizializza una nuova istanza della classe Foreach .

new ForEach()

ForEach(string, Dialog[])

Inizializza una nuova istanza della classe Foreach .

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

Parametri

itemsProperty

string

Espressione del percorso della proprietà per l'insieme di elementi.

actions

Dialog[]

Azioni da eseguire.

Dettagli proprietà

$kind

static $kind: string

Valore della proprietà

string

disabled

Espressione facoltativa che, se è true, disabiliterà questa azione.

disabled?: BoolExpression

Valore della proprietà

BoolExpression

index

Espressione del percorso della proprietà per l'indice dell'elemento.

index: StringExpression

Valore della proprietà

StringExpression

itemsProperty

Espressione del percorso della proprietà per l'insieme di elementi.

itemsProperty: StringExpression

Valore della proprietà

StringExpression

value

Espressione del percorso della proprietà al valore dell'elemento.

value: StringExpression

Valore della proprietà

StringExpression

Dettagli proprietà ereditate

actions

Azioni da eseguire.

actions: Dialog[]

Valore della proprietà

Dialog[]

ereditato daActionScope.actions

EndOfTurn

Ottiene un risultato di fine turno predefinito.

static EndOfTurn: DialogTurnResult

Valore della proprietà

DialogTurnResult

Commenti

Questo risultato indica che un dialogo (o un passaggio logico all'interno di una finestra di dialogo) ha completato l'elaborazione per il turno corrente, è ancora attiva ed è in attesa di più input.

ereditato da Dialog.EndOfTurn

id

id: string

Valore della proprietà

string

ereditato da Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Valore della proprietà

BotTelemetryClient

ereditato da Dialog.telemetryClient

Dettagli metodo

beginDialog(DialogContext, O)

Avvia un nuovo dialog e lo inserisce nello stack di dialoghi.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

_options

O

Opzionale. Informazioni iniziali da passare alla finestra di dialogo.

Restituisce

Promise<DialogTurnResult>

Oggetto Promise che rappresenta l'operazione asincrona.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parametri

property

Object

Chiave della configurazione del selettore condizionale.

Restituisce

Converter | ConverterFactory

Convertitore per la configurazione del selettore.

getDependencies()

Ottiene le dipendenze finestra di dialogo figlio in modo che possano essere aggiunte ai contenitori finestra di dialogo.

function getDependencies(): Dialog[]

Restituisce

Dialog[]

Le dipendenze della finestra di dialogo figlio.

Dettagli dei metodi ereditati

configure(Record<string, unknown>)

Metodo Fluent per la configurazione dell'oggetto.

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

Parametri

config

Record<string, unknown>

Impostazioni di configurazione da applicare.

Restituisce

this

Configurabile al termine dell'operazione.

Ereditato da Configurable.configure

continueDialog(DialogContext)

Chiamato quando la finestra di dialogo continua continua, dove è il dialogo attivo e l'utente risponde con una nuova attività.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

Restituisce

Promise<DialogTurnResult>

Oggetto Promise che rappresenta l'operazione asincrona.

ereditato daActionScope.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

Quando sottoposto a override in una classe derivata, esegue la pulizia per la finestra di dialogo prima che termini.

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

Parametri

_context

TurnContext

Oggetto di contesto per il turno.

_instance

DialogInstance

Informazioni sullo stato corrente per questa finestra di dialogo.

_reason

DialogReason

Motivo per cui la finestra di dialogo sta terminando.

Restituisce

Promise<void>

Commenti

Le finestre di dialogo derivate che devono eseguire la registrazione o la pulizia prima di terminare devono eseguire l'override di questo metodo. Per impostazione predefinita, questo metodo non ha alcun effetto.

Il DialogContext chiama questo metodo al termine della finestra di dialogo corrente.

Vedere anche

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

Ereditato da Dialog.endDialog

getVersion()

Ottiene un string univoco che rappresenta la versione di questa finestra di dialogo. Se la versione cambia tra turni il sistema del dialogo genererà un evento DialogChanged.

function getVersion(): string

Restituisce

string

Univoco string che deve cambiare solo quando la finestra di dialogo è cambiata in modo da riavviare la finestra di dialogo.

ereditato daActionScope.getVersion

onDialogEvent(DialogContext, DialogEvent)

Chiamato quando è stato generato un evento, utilizzando DialogContext.emitEvent(), dalla finestra di dialogo corrente o da una finestra di dialogo avviata dalla finestra di dialogo corrente.

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

Parametri

dc

DialogContext

Contesto del dialogo per il turno corrente della conversazione.

e

DialogEvent

Evento generato.

Restituisce

Promise<boolean>

True se l'evento viene gestito dalla finestra di dialogo corrente e il bubbling deve essere arrestato.

ereditato da Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Quando ne viene eseguito l'override in una classe derivata, reinserito l'utente per l'input.

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

Parametri

_context

TurnContext

Oggetto di contesto per il turno.

_instance

DialogInstance

Informazioni sullo stato corrente per questa finestra di dialogo.

Restituisce

Promise<void>

Commenti

I dialoghi derivati che supportano la convalida e la logica di ripetizione della richiesta devono eseguire l'override di questo metodo. Per impostazione predefinita, questo metodo non ha alcun effetto.

Il DialogContext chiama questo metodo quando la finestra di dialogo corrente deve richiedere nuovamente l'input dell'utente. Questo metodo viene implementato per i dialoghi di richiesta.

Vedere anche

• DialogContext.repromptDialog
• Prompt

ereditato da Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Chiamato quando un dialogo figlio completato il suo turno, restituendo il controllo a questa finestra di dialogo.

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

Parametri

dc

DialogContext

Il DialogContext per il turno di conversazione corrente.

_reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), motivo per cui il dialogo è ripreso.

result

any

Opzionale. Valore restituito dalla finestra di dialogo chiamata. Il tipo del valore restituito dipende dal dialogo figlio.

Restituisce

Promise<DialogTurnResult>

Oggetto Promise che rappresenta l'operazione asincrona.

Ereditato daActionScope.resumeDialog