WaterfallStepContext class

Crea una nuova istanza WaterfallStepContext.

new WaterfallStepContext(dc: DialogContext, info: WaterfallStepInfo<O>)

Parametri

DialogInstance | undefined activeDialog

Valore della proprietà

Informazioni sullo stato per il dialogo nella parte superiore dello stack di dialoghi o undefined se lo stack è vuoto.

DialogContext | undefined child

Valore della proprietà

Contesto del dialogo per figlio se il dialogo attivo è un contenitore.

DialogManager dialogManager

Valore della proprietà

Istanza corrente di Gestione dialoghi. Questa proprietà è deprecata.

Indice del passaggio a cascata corrente in esecuzione.

number index

Valore della proprietà

Indice del passaggio a cascata corrente in esecuzione.

Tutte le opzioni passate alla finestra di dialogo a cascata dei passaggi quando è stata avviata con DialogContext.beginDialog().

O options

Valore della proprietà

Tutte le opzioni con cui è stato chiamato il dialogo a cascata.

Motivo per cui viene eseguito il passaggio a cascata.

DialogReason reason

Valore della proprietà

Motivo per cui viene eseguito il passaggio a cascata.

Risultati restituiti da un dialogo o da un prompt chiamato nel passaggio a cascata precedente.

any result

Valore della proprietà

Risultato del passaggio a cascata precedente.

Dizionario di valori che verranno mantenuti in tutti i passaggi a cascata.

object values

Valore della proprietà

Dizionario di valori che verranno mantenuti in tutti i passaggi a cascata.

Ottiene l'oggetto contesto per il turno.

context: TurnContext

Valore della proprietà

ereditato daDialogContext.context

Ottiene i dialoghi che possono essere chiamati direttamente da questo contesto.

dialogs: DialogSet

Valore della proprietà

ereditato daDialogContext.dialogs

Contesto del dialogo padre per questo contesto di dialogo o undefined se questo contesto non ha un elemento padre.

parent: DialogContext | undefined

Valore della proprietà

Commenti

Quando tenta di avviare una finestra di dialogo, il contesto del dialogo cerca il Dialog.id nelle finestre di dialogo . Se il dialogo da avviare non viene trovato in questo contesto di dialogo, cerca nel contesto del dialogo padre e così via.

ereditato daDialogContext.parent

Ottiene la raccolta di servizi contestuale a questo contesto di dialogo.

services: TurnContextStateCollection

Valore della proprietà

ereditato daDialogContext.services

Ottiene lo stack di dialoghi corrente.

stack: DialogInstance[]

Valore della proprietà

ereditato daDialogContext.stack

Ottiene DialogStateManager che gestisce la visualizzazione di tutti gli ambiti di memoria.

state: DialogStateManager

Valore della proprietà

ereditato daDialogContext.state

Passa al passaggio successivo a cascata.

function next(result?: any): Promise<DialogTurnResult>

Parametri

Restituisce

Promessa con DialogTurnResult.

Commenti

return await step.skip();

Avvia un'istanza del dialogo e la inserisce nello stack di dialoghi. Crea una nuova istanza del dialogo e lo inserisce nello stack.

function beginDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

Parametri

Restituisce

una promessa che risolve il risultato del turno del dialogo.

Commenti

Se è già presente un dialogo attivo nello stack, tale finestra di dialogo verrà sospesa fino a quando non sarà nuovamente la finestra di dialogo superiore nello stack.

Lo stato dell'oggetto restituito descrive lo stato dello stack di dialoghi al termine di questo metodo.

Questo metodo genera un'eccezione se il dialogo richiesto non viene trovato in questo contesto di dialogo o in uno dei relativi predecessori.

Per esempio:

const result = await dc.beginDialog('greeting', { name: user.name });

Vedere anche

• endDialog
• prompt
• replaceDialog
• dialog.beginDialog

ereditato daDialogContext.beginDialog

Annulla tutti i dialoghi nello stack di dialoghi e cancella lo stack.

function cancelAllDialogs(cancelParents?: boolean, eventName?: string, eventValue?: any): Promise<DialogTurnResult>

Parametri

Restituisce

una promessa che risolve il risultato del turno del dialogo.

Commenti

Viene chiamato il metodo Dialog.endDia log di ogni dialogo prima di rimuovere il dialogo dallo stack.

Se inizialmente sono presenti dialoghi nello stack, lo stato del valore restituito viene annullato; in caso contrario, è vuoto.

In questo esempio viene cancellato uno stack di dialoghi, dc, prima di avviare una finestra di dialogo 'bookFlight'.

await dc.cancelAllDialogs();
return await dc.beginDialog('bookFlight');

Vedere anche

• endDialog

Ereditato daDialogContext.cancelAllDialogs

Continua l'esecuzione del dialogo attivo, se presente, passando questo contesto di dialogo al relativo metodo Dialog.continueDialog.

function continueDialog(): Promise<DialogTurnResult>

Restituisce

una promessa che risolve il risultato del turno del dialogo.

Commenti

Al termine della chiamata, è possibile controllare il contesto di turno ha risposto proprietà per determinare se la finestra di dialogo ha inviato una risposta all'utente.

Lo stato dell'oggetto restituito descrive lo stato dello stack di dialoghi al termine di questo metodo.

In genere, è necessario chiamare questa operazione dall'interno del gestore dei turni del bot.

Per esempio:

const result = await dc.continueDialog();
if (result.status == DialogTurnStatus.empty && dc.context.activity.type == ActivityTypes.message) {
    // Send fallback message
    await dc.context.sendActivity(`I'm sorry. I didn't understand.`);
}

ereditato daDialogContext.continueDialog

Cerca una finestra di dialogo con un ID specificato.

function emitEvent(name: string, value?: any, bubble?: boolean, fromLeaf?: boolean): Promise<boolean>

Parametri

Restituisce

true se l'evento è stato gestito.

Commenti

Genera un evento denominato per la finestra di dialogo corrente, o un utente che lo ha avviato, da gestire.

ereditato daDialogContext.emitEvent

Termina un dialogo e lo rimuove dallo stack. Restituisce un risultato facoltativo all'elemento padre del dialogo.

function endDialog(result?: any): Promise<DialogTurnResult>

Parametri

Restituisce

una promessa che risolve il risultato del turno del dialogo.

Commenti

La finestra di dialogo padre è la finestra di dialogo successiva nello stack di dialoghi, se presente. Questo metodo chiama il metodo dialog.resumeDialog dell'elemento padre, passando il risultato restituito dal dialogo finale. Se non è presente alcun dialogo padre, il turno termina e il risultato è disponibile per il bot tramite il risultato restituito proprietà.

Lo stato dell'oggetto restituito descrive lo stato dello stack di dialoghi al termine di questo metodo.

In genere, è necessario chiamare questa operazione dall'interno della logica per un dialogo specifico per segnalare al contesto del dialogo che il dialogo è stato completato, il dialogo deve essere rimosso dallo stack e il dialogo padre deve riprendere.

Per esempio:

return await dc.endDialog(returnValue);

Vedere anche

• beginDialog
• replaceDialog
• dialog.endDialog

ereditato daDialogContext.endDialog

Cerca una finestra di dialogo con un ID specificato.

function findDialog(dialogId: string): Dialog | undefined

Parametri

Restituisce

Finestra di dialogo per l'ID specificato.

Commenti

Se il dialogo da avviare non viene trovato nel DialogSet associato a questo contesto di dialogo, tenta di trovare il dialogo nel contesto del dialogo padre.

Vedere anche

• finestre di dialogo
• padre

ereditato daDialogContext.findDialog

Ottenere CultureInfo in DialogContext.

function getLocale(): string

Restituisce

stringa delle impostazioni locali.

ereditato daDialogContext.getLocale

Funzione helper per semplificare la formattazione delle opzioni per chiamare una finestra di dialogo di richiesta.

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions): Promise<DialogTurnResult>

Parametri

Restituisce

Commenti

Questo metodo helper formatta l'oggetto da usare come parametro options e quindi chiama beginDialog per avviare la finestra di dialogo di richiesta specificata.

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

ereditato daDialogContext.prompt

Funzione helper per semplificare la formattazione delle opzioni per chiamare una finestra di dialogo di richiesta.

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions, choices: string | Choice[]): Promise<DialogTurnResult>

Parametri

Restituisce

Commenti

Questo metodo helper formatta l'oggetto da usare come parametro options e quindi chiama beginDialog per avviare la finestra di dialogo di richiesta specificata.

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

ereditato daDialogContext.prompt

Termina il dialogo attivo e avvia una nuova finestra di dialogo al suo posto.

function replaceDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

Parametri

Restituisce

una promessa che risolve il risultato del turno del dialogo.

Commenti

Ciò è particolarmente utile per la creazione di un ciclo o il reindirizzamento a un'altra finestra di dialogo.

Lo stato dell'oggetto restituito descrive lo stato dello stack di dialoghi al termine di questo metodo.

Questo metodo è simile a quello di terminare il dialogo corrente e iniziare immediatamente quello nuovo. Tuttavia, la finestra di dialogo padre non viene ripresa né notificata in altro modo.

Vedere anche

• beginDialog
• endDialog

ereditato daDialogContext.replaceDialog

Richiede al dialogo attivo di richiedere di nuovo all'utente l'input.

function repromptDialog(): Promise<void>

Restituisce

Commenti

Viene chiamato il metodo di del dialogo attivo.

Per esempio:

await dc.repromptDialog();

ereditato daDialogContext.repromptDialog