SkillDialog Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.dialogs
Artefatto Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class SkillDialog
extends Dialog

Un Dialog specializzato in grado di eseguire il wrapping delle chiamate remote a una competenza. Il parametro options in BeginDialog deve essere un'istanza di BeginSkillDialogOptions con i parametri iniziali per la finestra di dialogo.

Riepilogo dei costruttori

Costruttore Descrizione
SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Inizializza una nuova istanza della classe SkillDialog per eseguire il wrapping delle chiamate remote a una competenza.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Chiamato quando viene avviato il dialogo di competenza e inserito nello stack di dialoghi.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Chiamato quando il dialogo di competenza è _continue_, dove è il dialogo attivo e l'utente risponde con una nuova attività.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Chiamato quando termina il dialogo della competenza.
protected SkillDialogOptions getDialogOptions()

Ottiene le opzioni utilizzate per eseguire la finestra di dialogo delle competenze.
protected boolean onValidateActivity(Activity activity)

Convalida l'attività inviata durante la finestra di dialogo Continua.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Chiamato quando la finestra di dialogo della competenza deve richiedere di nuovo all'utente l'input.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

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

Metodi ereditati da Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Metodi ereditati da java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Dettagli costruttore

SkillDialog

public SkillDialog(SkillDialogOptions dialogOptions, String dialogId)

Inizializza una nuova istanza della classe SkillDialog per eseguire il wrapping delle chiamate remote a una competenza.

Parametri:

dialogOptions - Opzioni per eseguire la finestra di dialogo delle competenze.
dialogId - ID del dialogo.

Dettagli metodo

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Chiamato quando viene avviato il dialogo di competenza e inserito nello stack di dialoghi.

Override:

SkillDialog.beginDialog(DialogContext dc, Object options)

Parametri:

dc - Il DialogContext per il turno di conversazione corrente.
options - Informazioni iniziali facoltative da passare alla finestra di dialogo.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

Override:

SkillDialog.continueDialog(DialogContext dc)

Parametri:

dc - Il DialogContext per il turno di conversazione corrente.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Chiamato quando termina il dialogo della competenza.

Override:

SkillDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Parametri:

turnContext - Oggetto di contesto per questo turno.
instance - Informazioni sullo stato associate all'istanza di questa finestra di dialogo nello stack di dialoghi.
reason - Motivo per cui il dialogo è terminato.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona.

getDialogOptions

protected SkillDialogOptions getDialogOptions()

Ottiene le opzioni utilizzate per eseguire la finestra di dialogo delle competenze.

Restituisce:

Valore DialogOptions come SkillDialogOptions.

onValidateActivity

protected boolean onValidateActivity(Activity activity)

Convalida l'attività inviata durante ContinueDialog.

Parametri:

activity - Il Activity per il turno di conversazione corrente. 
             Override this method to implement a custom validator for the
             activity being sent during the ContinueDialog . This
             method can be used to ignore activities of a certain type if
             needed. If this method returns false, the dialog will end the
             turn without processing the activity.

Restituisce:

true se l'attività è valida, false in caso contrario.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Chiamato quando la finestra di dialogo della competenza deve richiedere di nuovo all'utente l'input.

Override:

SkillDialog.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parametri:

turnContext - Oggetto di contesto per questo turno.
instance - Informazioni sullo stato per questa finestra di dialogo.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

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

Override:

SkillDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.
reason - Motivo per cui il dialogo è stato ripreso.
result - Valore facoltativo restituito dalla finestra di dialogo chiamata. Il tipo del valore restituito dipende dal dialogo figlio.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona.

Si applica a