DialogContext Kelas

Paket:

com.microsoft.bot.dialogs

Maven Artifact:

com.microsoft.bot:bot-dialogs:4.14.3

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

public class DialogContext

Menyediakan konteks untuk status tumpukan dialog saat ini.

Ringkasan Konstruktor

Konstruktor	Deskripsi
DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)	Menginisialisasi instans baru kelas DialogKonteks dari konteks giliran.
DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)	Menginisialisasi instans baru kelas DialogKonteks dari konteks giliran.

Ringkasan Metode

Pemodifikasi dan Jenis	Metode dan Deskripsi
java.util.concurrent.CompletableFuture<DialogTurnResult>	beginDialog(String dialogId) Memulai dialog baru dan mendorongnya ke tumpukan dialog.
java.util.concurrent.CompletableFuture<DialogTurnResult>	beginDialog(String dialogId, Object options) Memulai dialog baru dan mendorongnya ke tumpukan dialog.
java.util.concurrent.CompletableFuture<DialogTurnResult>	cancelAllDialogs() Metode pembantu untuk cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) yang tidak membatalkan dialog atau kejadian induk.
java.util.concurrent.CompletableFuture<DialogTurnResult>	cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) Menghapus tumpukan dialog yang ada sehingga membatalkan semua dialog pada tumpukan.
java.util.concurrent.CompletableFuture<DialogTurnResult>	continueDialog() Melanjutkan eksekusi dialog aktif, jika ada, dengan meneruskan Dialog saat iniKonteks ke metode continueDialog(DialogContext dc) dialog aktif.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	emitEvent(String name)
java.util.concurrent.CompletableFuture<java.lang.Boolean>	emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)
java.util.concurrent.CompletableFuture<DialogTurnResult>	endDialog() Metode pembantu yang memasok hasil null ke endDialog(Object result).
java.util.concurrent.CompletableFuture<DialogTurnResult>	endDialog(Object result) Mengakhiri dialog dengan memunculkannya dari tumpukan dan mengembalikan hasil opsional ke induk dialog.
Dialog	findDialog(String dialogId) Temukan id dialog untuk konteks yang diberikan.
DialogInstance	getActiveDialog() Mendapatkan instans yang di-cache dari dialog aktif di bagian atas tumpukan atau null jika tumpukan kosong.
DialogContext	getChild() Mendapatkan konteks dialog untuk anak jika ada anak yang aktif.
TurnContext	getContext() Mendapatkan konteks untuk pergantian percakapan saat ini.
DialogSet	getDialogs() Mendapatkan kumpulan dialog yang aktif untuk kontainer dialog saat ini.
java.lang.String	getLocale() Dapatkan lokal dalam KonteksDialog.
DialogContext	getParent() Mendapatkan Dialog indukKonteks, jika ada.
TurnContextStateCollection	getServices() Mendapatkan kumpulan layanan yang kontekstual dengan konteks dialog ini.
java.util.List<DialogInstance>	getStack() Mendapatkan tumpukan dialog saat ini.
DialogStateManager	getState() Mendapatkan atau mengatur DialogStateManager yang mengelola tampilan semua cakupan memori.
java.util.concurrent.CompletableFuture<DialogTurnResult>	prompt(String dialogId, PromptOptions options) Fungsi pembantu untuk menyederhanakan pemformatan opsi untuk memanggil dialog perintah.
java.util.concurrent.CompletableFuture<DialogTurnResult>	replaceDialog(String dialogId) Metode pembantu untuk replaceDialog(String dialogId, Object options) yang melewati null untuk opsi.
java.util.concurrent.CompletableFuture<DialogTurnResult>	replaceDialog(String dialogId, Object options) Memulai dialog baru dan mengganti pada tumpukan dialog yang saat ini aktif dengan dialog baru.
java.util.concurrent.CompletableFuture<java.lang.Void>	repromptDialog() Memanggil metode repromptDialog(TurnContext turnContext, DialogInstance instance) dialog yang saat ini aktif.
void	setParent(DialogContext withDialogContext) Atur Dialog indukKonteks.

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 Konstruktor

DialogContext

public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

Menginisialisasi instans baru kelas DialogContext dari konteks giliran.

Parameter:

withDialogs - Dialog diatur untuk membuat konteks dialog.

withTurnContext - Konteks giliran saat ini.

withState - Properti status tempat untuk mengambil konteks dialog.

DialogContext

public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

Menginisialisasi instans baru kelas DialogContext dari konteks giliran.

Parameter:

withDialogs - Dialog diatur untuk membuat konteks dialog.

withParentDialogContext - Konteks dialog induk.

withState - Status dialog saat ini.

Detail Metode

beginDialog

public CompletableFuture beginDialog(String dialogId)

Memulai dialog baru dan mendorongnya ke tumpukan dialog.

Parameter:

dialogId - ID dialog untuk memulai.

Mengembalikan:

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

beginDialog

public CompletableFuture beginDialog(String dialogId, Object options)

Memulai dialog baru dan mendorongnya ke tumpukan dialog.

Parameter:

dialogId - ID dialog untuk memulai.

options - Opsional, informasi untuk diteruskan ke dialog yang sedang dimulai.

Mengembalikan:

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

cancelAllDialogs

public CompletableFuture cancelAllDialogs()

Metode pembantu untuk cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) yang tidak membatalkan dialog atau kejadian induk.

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan bahwa dialog dibatalkan setelah giliran diproses oleh dialog atau tumpukan sudah kosong.

cancelAllDialogs

public CompletableFuture cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

Menghapus tumpukan dialog yang ada sehingga membatalkan semua dialog pada tumpukan.

Secara umum, konteks induk adalah penangan giliran dialog atau bot yang memulai dialog. Jika induk adalah dialog, tumpukan memanggil metode resumeDialog(DialogContext dc, DialogReason reason, Object result) induk untuk mengembalikan hasil ke dialog induk. Jika dialog induk tidak menerapkan Dialog#resumeDialog, maka induk juga akan berakhir, dan hasilnya diteruskan ke konteks induk berikutnya.

Parameter:

cancelParents - Jika benar, pembatalan juga akan muncul melalui dialog induk apa pun.

eventName - Acaranya. Jika null, CANCEL_DIALOG digunakan.

eventValue - Nilai peristiwa. Bisa null.

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan bahwa dialog dibatalkan setelah giliran diproses oleh dialog atau tumpukan sudah kosong.

continueDialog

public CompletableFuture continueDialog()

Melanjutkan eksekusi dialog aktif, jika ada, dengan meneruskan DialogContext saat ini ke metode continueDialog(DialogContext dc) dialog aktif.

Mengembalikan:

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

emitEvent

public CompletableFuture emitEvent(String name)

Parameter:

name - Nama acara yang akan dinaikkan.

Mengembalikan:

emitEvent

emitEvent

public CompletableFuture emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)

Parameter:

name - Nama acara yang akan dinaikkan.

value - Nilai yang akan dikirim bersama dengan peristiwa.

bubble - Bendera untuk mengontrol apakah peristiwa harus dibenturkan ke induknya jika tidak ditangani secara lokal. Default ke nilai true.

fromLeaf - Apakah peristiwa dipancarkan dari simpul daun.

Mengembalikan:

completedFuture

endDialog

public CompletableFuture endDialog()

Metode pembantu yang memasok hasil null ke endDialog(Object result).

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan bahwa dialog berakhir setelah giliran diproses oleh dialog.

endDialog

public CompletableFuture endDialog(Object result)

Mengakhiri dialog dengan memunculkannya dari tumpukan dan mengembalikan hasil opsional ke induk dialog. Dialog induk adalah dialog memulai memulai yang diakhir melalui panggilan ke beginDialog(String dialogId, Object options) atau prompt(String dialogId, PromptOptions options). Dialog induk akan meminta metode resumeDialog(DialogContext dc, DialogReason reason, Object result) dengan hasil yang dikembalikan. Jika dialog induk belum menerapkan metode resumeDialog(DialogContext dc, DialogReason reason), maka akan secara otomatis berakhir juga dan hasilnya diteruskan ke induknya. Jika tidak ada lagi dialog induk pada tumpukan maka pemrosesan giliran akan berakhir.

Parameter:

result - Opsional, menghasilkan untuk meneruskan ke konteks induk.

Mengembalikan:

Jika tugas berhasil, hasilnya menunjukkan bahwa dialog berakhir setelah giliran diproses oleh dialog.

findDialog

public Dialog findDialog(String dialogId)

Temukan id dialog untuk konteks yang diberikan.

Parameter:

dialogId - id dialog untuk ditemukan.

Mengembalikan:

dialog dengan id tersebut, atau null.

getActiveDialog

public DialogInstance getActiveDialog()

Mendapatkan instans yang di-cache dari dialog aktif di bagian atas tumpukan atau null jika tumpukan kosong.

Mengembalikan:

Instans yang di-cache dari dialog aktif di bagian atas tumpukan atau null jika tumpukan kosong.

getChild

public DialogContext getChild()

Mendapatkan konteks dialog untuk anak jika ada anak yang aktif.

Mengembalikan:

Konteks dialog untuk anak jika ada anak aktif.

getContext

public TurnContext getContext()

Mendapatkan konteks untuk pergantian percakapan saat ini.

Mengembalikan:

Konteks untuk pergantian percakapan saat ini.

getDialogs

public DialogSet getDialogs()

Mendapatkan kumpulan dialog yang aktif untuk kontainer dialog saat ini.

Mengembalikan:

Kumpulan dialog yang aktif untuk kontainer dialog saat ini.

getLocale

public String getLocale()

Dapatkan lokal di DialogContext.

Mengembalikan:

String yang mewakili lokal saat ini.

getParent

public DialogContext getParent()

Mendapatkan DialogContext induk, jika ada. Digunakan saat mencari ID dialog untuk memulai.

Mengembalikan:

Induk "DialogContext, jika ada. Digunakan saat mencari ID dialog untuk memulai.

getServices

public TurnContextStateCollection getServices()

Mendapatkan kumpulan layanan yang kontekstual dengan konteks dialog ini.

Mengembalikan:

Koleksi layanan.

getStack

public List getStack()

Mendapatkan tumpukan dialog saat ini.

Mengembalikan:

Tumpukan dialog saat ini.

getState

public DialogStateManager getState()

Mendapatkan atau mengatur DialogStateManager yang mengelola tampilan semua cakupan memori.

Mengembalikan:

DialogStateManager dengan tampilan memori terpadu dari semua cakupan memori.

prompt

public CompletableFuture prompt(String dialogId, PromptOptions options)

Fungsi pembantu untuk menyederhanakan pemformatan opsi untuk memanggil dialog perintah. Pembantu ini akan mengambil argumen PromptOptions lalu memanggil beginDialog(String dialogId, Object options)

Parameter:

dialogId - ID dialog perintah untuk memulai.

options - Informasi untuk diteruskan ke dialog perintah yang sedang dimulai.

Mengembalikan:

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

replaceDialog

public CompletableFuture replaceDialog(String dialogId)

Metode pembantu untuk replaceDialog(String dialogId, Object options) yang melewati null untuk opsi.

Parameter:

dialogId - ID dialog baru untuk memulai.

Mengembalikan:

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

replaceDialog

public CompletableFuture replaceDialog(String dialogId, Object options)

Memulai dialog baru dan mengganti pada tumpukan dialog yang saat ini aktif dengan dialog baru. Ini sangat berguna untuk membuat perulangan atau mengalihkan ke dialog lain.

Parameter:

dialogId - ID dialog baru untuk memulai.

options - Opsional, informasi untuk diteruskan ke dialog yang sedang dimulai.

Mengembalikan:

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

repromptDialog

public CompletableFuture repromptDialog()

Memanggil metode repromptDialog(TurnContext turnContext, DialogInstance instance) dialog yang saat ini aktif. Digunakan dengan dialog yang mengimplementasikan perilaku perintah ulang.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

setParent

public void setParent(DialogContext withDialogContext)

Atur DialogContext induk.

Parameter:

withDialogContext - DialogContext untuk mengatur induk ke.