Dialog Kelas

Paket:

com.microsoft.bot.dialogs

Maven Artifact:

com.microsoft.bot:bot-dialogs:4.14.3

• java.lang.Object
• • com.microsoft.bot.dialogs.Dialog

public abstract class Dialog

Kelas dasar untuk semua dialog.

Ringkasan Bidang

Pemodifikasi dan Jenis	Bidang dan Deskripsi
static final DialogTurnResult	END_OF_TURN DialogTurnResult yang menunjukkan bahwa dialog saat ini masih aktif dan menunggu input dari pengguna berikutnya.

Ringkasan Konstruktor

Konstruktor	Deskripsi
Dialog(String dialogId)	Menginisialisasi instans baru kelas Dialog.

Ringkasan Metode

Pemodifikasi dan Jenis	Metode dan Deskripsi
java.util.concurrent.CompletableFuture<DialogTurnResult>	beginDialog(DialogContext dc) Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.
abstract java.util.concurrent.CompletableFuture<DialogTurnResult>	beginDialog(DialogContext dc, Object options) Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.
java.util.concurrent.CompletableFuture<DialogTurnResult>	continueDialog(DialogContext dc) Dipanggil saat dialog _continued_, di mana dialog aktif dan pengguna membalas dengan aktivitas baru.
java.util.concurrent.CompletableFuture<java.lang.Void>	endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason) Dipanggil saat dialog berakhir.
java.lang.String	getId() Mendapatkan id untuk dialog.
BotTelemetryClient	getTelemetryClient() Mendapatkan BotTelemetryClient yang digunakan untuk pengelogan.
java.lang.String	getVersion() Mendapatkan String unik yang mewakili versi dialog ini.
protected static java.util.concurrent.CompletableFuture<DialogTurnResult>	innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration) Implementasi bersama eksekusi dengan Dialog dan DialogManager.
protected java.lang.String	onComputeId() Menghitung id untuk Dialog.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	onDialogEvent(DialogContext dc, DialogEvent e) Dipanggil saat peristiwa telah dinaikkan, menggunakan 'DialogKonteks.memancarkanEvent()', baik dengan dialog saat ini atau dialog yang dimulai dialog saat ini.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean>	onPostBubbleEvent(DialogContext dc, DialogEvent e) Dipanggil setelah peristiwa digelembungkan ke semua orang tua dan tidak ditangani.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean>	onPreBubbleEvent(DialogContext dc, DialogEvent e) Dipanggil sebelum peristiwa digelembungkan ke induknya.
java.util.concurrent.CompletableFuture<java.lang.Void>	repromptDialog(TurnContext turnContext, DialogInstance instance) Dipanggil ketika dialog harus meminta kembali input kepada pengguna.
java.util.concurrent.CompletableFuture<DialogTurnResult>	resumeDialog(DialogContext dc, DialogReason reason) Dipanggil ketika dialog turunan menyelesaikan giliran ini, mengembalikan kontrol ke dialog ini.
java.util.concurrent.CompletableFuture<DialogTurnResult>	resumeDialog(DialogContext dc, DialogReason reason, Object result) Dipanggil ketika dialog turunan menyelesaikan giliran ini, mengembalikan kontrol ke dialog ini.
static java.util.concurrent.CompletableFuture<java.lang.Void>	run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor) Membuat tumpukan dialog dan memulai dialog, mendorongnya ke tumpukan.
void	setId(String withId) Mengatur id untuk dialog.
void	setTelemetryClient(BotTelemetryClient withTelemetryClient) Mengatur BotTelemetryClient yang akan digunakan untuk pengelogan.

Metode diperoleh dari 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

Detail Bidang

END_OF_TURN

public static final DialogTurnResult END_OF_TURN

DialogTurnResult yang menunjukkan bahwa dialog saat ini masih aktif dan menunggu input dari pengguna berikutnya.

Detail Konstruktor

Dialog

public Dialog(String dialogId)

Menginisialisasi instans baru kelas Dialog.

Parameter:

dialogId - ID yang akan ditetapkan ke dialog ini.

Detail Metode

beginDialog

public CompletableFuture beginDialog(DialogContext dc)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.

Parameter:

dc - DialogContext untuk pergantian percakapan saat ini.

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog.

beginDialog

public abstract CompletableFuture beginDialog(DialogContext dc, Object options)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.

Parameter:

dc - DialogContext untuk pergantian percakapan saat ini.

options - Informasi awal untuk diteruskan ke dialog.

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Dipanggil saat dialog _continued_, di mana dialog aktif dan pengguna membalas dengan aktivitas baru.

Jika metode ini *tidak* ditimpa, dialog akan otomatis berakhir saat pengguna membalas.

Parameter:

dc - DialogContext untuk pergantian percakapan saat ini.

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog. Hasilnya mungkin juga berisi nilai pengembalian.

endDialog

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

Dipanggil saat dialog berakhir.

Parameter:

turnContext - Objek konteks untuk giliran ini.

instance - Informasi status yang terkait dengan instans dialog ini pada tumpukan dialog.

reason - Alasan mengapa dialog berakhir.

Mengembalikan:

CompletableFuture yang mewakili operasi asinkron.

getId

public String getId()

Mendapatkan id untuk dialog.

Mengembalikan:

Id untuk dialog.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Mendapatkan BotTelemetryClient yang digunakan untuk pengelogan.

Mengembalikan:

BotTelemetryClient yang digunakan untuk pengelogan.

getVersion

public String getVersion()

Mendapatkan String unik yang mewakili versi dialog ini. Jika versi berubah antara mengubah sistem dialog akan memancarkan peristiwa DialogChanged.

Mengembalikan:

String Unik yang seharusnya hanya berubah ketika dialog telah berubah dengan cara yang harus menghidupkan ulang dialog.

innerRun

protected static CompletableFuture innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implementasi bersama eksekusi dengan Dialog dan DialogManager.

Parameter:

turnContext - TurnContext.

dialogId - The Id of the Dialog.

dialogContext - The DialogContext.

stateConfiguration - The DialogStateManagerConfiguration.

Mengembalikan:

A DialogTurnResult.

onComputeId

protected String onComputeId()

Menghitung id untuk Dialog.

Mengembalikan:

Id.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

Dipanggil ketika peristiwa telah dinaikkan, menggunakan 'DialogContext.emitEvent()', dengan dialog saat ini atau dialog yang dimulai dialog saat ini.

Parameter:

dc - Konteks dialog untuk pergantian percakapan saat ini.

e - Peristiwa yang sedang dinaikkan.

Mengembalikan:

True jika peristiwa ditangani oleh dialog saat ini dan gelembung harus berhenti.

onPostBubbleEvent

protected CompletableFuture onPostBubbleEvent(DialogContext dc, DialogEvent e)

Dipanggil setelah peristiwa digelembungkan ke semua orang tua dan tidak ditangani.

Ini adalah tempat yang baik untuk melakukan logika pemrosesan default untuk suatu peristiwa. Mengembalikan 'true' akan mencegah pemrosesan peristiwa berdasarkan dialog anak.

Parameter:

dc - Konteks dialog untuk pergantian percakapan saat ini.

e - Peristiwa yang sedang dinaikkan.

Mengembalikan:

Apakah peristiwa ditangani oleh dialog saat ini dan pemrosesan lebih lanjut harus berhenti.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Dipanggil sebelum peristiwa digelembungkan ke induknya.

Ini adalah tempat yang baik untuk melakukan penyadapan peristiwa sebagai mengembalikan 'true' akan mencegah gelembung peristiwa lebih lanjut kepada orang tua dialog dan juga akan mencegah dialog anak melakukan pemrosesan default mereka.

Parameter:

dc - Konteks dialog untuk pergantian percakapan saat ini.

e - Peristiwa yang sedang dinaikkan.

Mengembalikan:

Apakah peristiwa ditangani oleh dialog saat ini dan pemrosesan lebih lanjut harus berhenti.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Dipanggil ketika dialog harus meminta kembali input kepada pengguna.

Parameter:

turnContext - Objek konteks untuk giliran ini.

instance - Informasi status untuk dialog ini.

Mengembalikan:

CompletableFuture yang mewakili operasi asinkron.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason)

Dipanggil ketika dialog turunan menyelesaikan giliran ini, mengembalikan kontrol ke dialog ini.

Umumnya, dialog anak dimulai dengan panggilan ke beginDialog(DialogContext dc, Object options) Namun, jika metode replaceDialog(String dialogId) dipanggil, dialog anak logis mungkin berbeda dari yang asli.

Jika metode ini *tidak* ditimpa, dialog akan otomatis berakhir saat pengguna membalas.

Parameter:

dc - Konteks dialog untuk pergantian percakapan saat ini.

reason - Alasan mengapa dialog dilanjutkan.

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan apakah dialog ini masih aktif setelah giliran dialog ini diproses.

resumeDialog

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

Dipanggil ketika dialog turunan menyelesaikan giliran ini, mengembalikan kontrol ke dialog ini.

Umumnya, dialog anak dimulai dengan panggilan ke beginDialog(DialogContext dc, Object options) Namun, jika metode replaceDialog(String dialogId, Object options) dipanggil, dialog anak logis mungkin berbeda dari yang asli.

Jika metode ini *tidak* ditimpa, dialog akan otomatis berakhir saat pengguna membalas.

Parameter:

dc - Konteks dialog untuk pergantian percakapan saat ini.

reason - Alasan mengapa dialog dilanjutkan.

result - Opsional, nilai yang dikembalikan dari dialog yang dipanggil. Jenis nilai yang dikembalikan tergantung pada dialog anak.

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan apakah dialog ini masih aktif setelah giliran dialog ini diproses.

run

public static CompletableFuture run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor accessor)

Membuat tumpukan dialog dan memulai dialog, mendorongnya ke tumpukan.

Parameter:

dialog - Dialog untuk memulai.

turnContext - Konteks untuk pergantian percakapan saat ini.

accessor - Pengaktif StatePropertyAccessor untuk mengelola status tumpukan dialog.

Mengembalikan:

Tugas yang mewakili operasi asinkron.

setId

public void setId(String withId)

Mengatur id untuk dialog.

Parameter:

withId - Id untuk dialog.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Mengatur BotTelemetryClient yang akan digunakan untuk pengelogan.

Parameter:

withTelemetryClient - BotTelemetryClient yang digunakan untuk pengelogan.