Case class
Casi di ambito dell'azione.
- Extends
Costruttori
| Case(string, Dialog[]) | Inizializza una nuova istanza della classe Case |
Proprietà
| value | Ottiene o imposta un'espressione di valore da confrontare con la condizione. |
Proprietà ereditate
| actions | Azioni da eseguire. |
| End |
Ottiene un risultato di fine turno predefinito. |
| id | |
| telemetry |
Metodi ereditati
| begin |
Viene chiamato all'avvio della finestra di dialogo ed è stato eseguito il push nello stack di dialoghi. |
| configure(Record<string, unknown>) | Metodo Fluent per la configurazione dell'oggetto. |
| continue |
Chiamato quando la finestra di dialogo continua continua, dove è il dialogo attivo e l'utente risponde con una nuova attività. |
| end |
Quando sottoposto a override in una classe derivata, esegue la pulizia per la finestra di dialogo prima che termini. |
| get |
|
| get |
Ottiene le dipendenze finestra di dialogo figlio in modo che possano essere aggiunte ai contenitori finestra di dialogo. |
| get |
Ottiene un |
| on |
Chiamato quando è stato generato un evento, utilizzando |
| reprompt |
Quando ne viene eseguito l'override in una classe derivata, reinserito l'utente per l'input. |
| resume |
Chiamato quando un dialogo figlio completato il suo turno, restituendo il controllo a questa finestra di dialogo. |
Dettagli costruttore
Case(string, Dialog[])
Inizializza una nuova istanza della classe Case
new Case(value?: string, actions?: Dialog[])Parametri
- value
-
string
Opzionale. Valore stringa del case.
- actions
-
Dialog[]
Opzionale. Elenco numerabile di azioni dialog.
Dettagli proprietà
value
Ottiene o imposta un'espressione di valore da confrontare con la condizione.
value: stringValore della proprietà
string
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: DialogTurnResultValore 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: stringValore della proprietà
string
ereditato da Dialog.id
telemetryClient
telemetryClient: BotTelemetryClientValore della proprietà
BotTelemetryClient
ereditato da Dialog.telemetryClient
Dettagli dei metodi ereditati
beginDialog(DialogContext, O)
Viene chiamato all'avvio della finestra di dialogo ed è stato eseguito il push 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.
ereditato daActionScope.beginDialog
configure(Record<string, unknown>)
Metodo Fluent per la configurazione dell'oggetto.
function configure(config: Record<string, unknown>): thisParametri
- 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
Ereditato da Dialog.endDialog
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactoryParametri
- property
-
Object
Chiave della configurazione del selettore condizionale.
Restituisce
Converter | ConverterFactory
Convertitore per la configurazione del selettore.
ereditato daActionScope.getConverter
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
ereditato daActionScope.getDependencies
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(): stringRestituisce
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
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