TurnContext Antarmuka

Paket:

com.microsoft.bot.builder

Maven Artifact:

com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

Menyediakan konteks untuk pergantian bot.

Konteks menyediakan informasi yang diperlukan untuk memproses aktivitas masuk. Objek konteks dibuat oleh BotAdapter dan bertahan selama pergantian.

Bot Middleware

Ringkasan Bidang

Pemodifikasi dan Jenis	Bidang dan Deskripsi
static final java.lang.String	STATE_TURN_LOCALE

Ringkasan Metode

Pemodifikasi dan Jenis	Metode dan Deskripsi
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(ConversationReference conversationReference) Menghapus aktivitas yang ada.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(String activityId) Menghapus aktivitas yang ada.
abstract Activity	getActivity() Mendapatkan aktivitas untuk giliran bot ini.
abstract BotAdapter	getAdapter() Mendapatkan adaptor bot yang membuat objek konteks ini.
abstract java.lang.String	getLocale() Mendapatkan lokal pada objek konteks ini.
abstract boolean	getResponded() Mendapatkan nilai yang menunjukkan apakah setidaknya satu respons dikirim untuk giliran saat ini.
abstract TurnContextStateCollection	getTurnState() Mendapatkan kumpulan nilai yang di-cache dengan objek konteks selama masa pakai giliran.
abstract TurnContext	onDeleteActivity(DeleteActivityHandler handler) Menambahkan handler respons untuk menghapus operasi aktivitas.
abstract TurnContext	onSendActivities(SendActivitiesHandler handler) Menambahkan handler respons untuk operasi aktivitas pengiriman.
abstract TurnContext	onUpdateActivity(UpdateActivityHandler handler) Menambahkan handler respons untuk operasi aktivitas pembaruan.
default java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(Activity[] activities) Metode pembantu untuk mengirim array Aktivitas.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(List<Activity> activities) Mengirim daftar aktivitas ke pengirim aktivitas masuk.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(Activity activity) Mengirim aktivitas ke pengirim aktivitas masuk.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend) Mengirim aktivitas pesan ke pengirim aktivitas masuk.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak) Mengirim aktivitas pesan ke pengirim aktivitas masuk.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak, InputHints inputHint) Mengirim aktivitas pesan ke pengirim aktivitas masuk.
default java.util.concurrent.CompletableFuture<java.lang.Void>	sendActivityBlind(Activity activity) Mengirim Aktivitas ke pengirim Aktivitas masuk tanpa mengembalikan ResponsSumber Daya.
abstract void	setLocale(String withLocale) Atur lokal pada objek konteks ini.
static java.util.concurrent.CompletableFuture<ResourceResponse>	traceActivity(TurnContext turnContext, String name)
static java.util.concurrent.CompletableFuture<ResourceResponse>	traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label) Mengirim aktivitas pelacakan ke BotAdapter untuk tujuan pengelogan.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(Activity withActivity) Menggantikan aktivitas yang ada.

Detail Bidang

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

Detail Metode

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

Menghapus aktivitas yang ada.

Parameter:

conversationReference - Percakapan yang berisi aktivitas yang akan dihapus.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan. Referensi percakapan ConversationReference#getActivityId menunjukkan aktivitas dalam percakapan yang akan dihapus.

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

Menghapus aktivitas yang ada.

Parameter:

activityId - ID aktivitas yang akan dihapus.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

getActivity

public abstract Activity getActivity()

Mendapatkan aktivitas untuk giliran bot ini.

Mengembalikan:

Aktivitas untuk pergantian bot ini.

getAdapter

public abstract BotAdapter getAdapter()

Mendapatkan adaptor bot yang membuat objek konteks ini.

Mengembalikan:

Adaptor bot yang membuat objek konteks ini.

getLocale

public abstract String getLocale()

Mendapatkan lokal pada objek konteks ini.

Mengembalikan:

String lokal pada objek konteks ini.

getResponded

public abstract boolean getResponded()

Mendapatkan nilai yang menunjukkan apakah setidaknya satu respons dikirim untuk giliran saat ini.

Mengembalikan:

true jika setidaknya satu respons dikirim untuk giliran saat ini; jika tidak, false.

getTurnState

public abstract TurnContextStateCollection getTurnState()

Mendapatkan kumpulan nilai yang di-cache dengan objek konteks selama masa pakai giliran.

Mengembalikan:

Kumpulan layanan yang terdaftar pada objek konteks ini.

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Menambahkan handler respons untuk menghapus operasi aktivitas.

Ketika deleteActivity(String activityId) konteks dipanggil, adaptor memanggil handler terdaftar dalam urutan ditambahkan ke objek konteks.

Parameter:

handler - Handler untuk ditambahkan ke objek konteks.

Mengembalikan:

Objek konteks yang diperbarui.

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Menambahkan handler respons untuk operasi aktivitas pengiriman.

Ketika metode konteks sendActivity(Activity activity) atau sendActivities(List<Activity> activities) dipanggil, adaptor memanggil handler terdaftar dalam urutan ditambahkan ke objek konteks.

Parameter:

handler - Handler untuk ditambahkan ke objek konteks.

Mengembalikan:

Objek konteks yang diperbarui.

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Menambahkan handler respons untuk operasi aktivitas pembaruan.

Ketika updateActivity(Activity withActivity) konteks dipanggil, adaptor memanggil handler terdaftar dalam urutan ditambahkan ke objek konteks.

Parameter:

handler - Handler untuk ditambahkan ke objek konteks.

Mengembalikan:

Objek konteks yang diperbarui.

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

Metode pembantu untuk mengirim array Aktivitas. Ini memanggil sendActivities(List<Activity> activities).

Parameter:

activities - Array aktivitas.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

sendActivities

public abstract CompletableFuture sendActivities(List activities)

Mengirim daftar aktivitas ke pengirim aktivitas masuk.

Jika aktivitas berhasil dikirim, hasil tugas berisi array objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas.

Parameter:

activities - Kegiatan yang akan dikirim.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

Mengirim aktivitas ke pengirim aktivitas masuk.

Parameter:

activity - Aktivitas yang akan dikirim.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan. Jika aktivitas berhasil dikirim, hasil tugas berisi objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

Mengirim aktivitas pesan ke pengirim aktivitas masuk.

Jika aktivitas berhasil dikirim, hasil tugas berisi objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas.

Lihat dokumentasi saluran untuk batas yang diberlakukan pada konten textReplyToSend.

Parameter:

textReplyToSend - Teks pesan yang akan dikirim.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

Mengirim aktivitas pesan ke pengirim aktivitas masuk.

Jika aktivitas berhasil dikirim, hasil tugas berisi objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas.

Lihat dokumentasi saluran untuk batas yang diberlakukan pada konten textReplyToSend.

Untuk mengontrol berbagai karakteristik ucapan bot Anda seperti suara, laju, volume, pengucapan, dan nada, tentukan speak dalam format Speech Synthesis Markup Language (SSML).

Parameter:

textReplyToSend - Teks pesan yang akan dikirim.

speak - Opsional, teks yang akan diucapkan oleh bot Anda di saluran yang mendukung ucapan.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Mengirim aktivitas pesan ke pengirim aktivitas masuk.

Jika aktivitas berhasil dikirim, hasil tugas berisi objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas.

Lihat dokumentasi saluran untuk batas yang diberlakukan pada konten textReplyToSend.

Untuk mengontrol berbagai karakteristik ucapan bot Anda seperti suara, laju, volume, pengucapan, dan nada, tentukan speak dalam format Speech Synthesis Markup Language (SSML).

Parameter:

textReplyToSend - Teks pesan yang akan dikirim.

speak - Opsional, teks yang akan diucapkan oleh bot Anda di saluran yang mendukung ucapan.

inputHint - Opsional, menunjukkan apakah bot Anda menerima, mengharapkan, atau mengabaikan input pengguna setelah pesan dikirimkan ke klien. Salah satu: "acceptingInput", "ignoringInput", atau "expectingInput". Defaultnya adalah "acceptingInput".

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

Mengirim Aktivitas ke pengirim Aktivitas masuk tanpa mengembalikan ResourceResponse.

Parameter:

activity - Aktivitas yang akan dikirim.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

setLocale

public abstract void setLocale(String withLocale)

Atur lokal pada objek konteks ini.

Parameter:

withLocale - String lokal pada objek konteks ini.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

Parameter:

turnContext - TurnContext.

name - Nama aktivitas.

Mengembalikan:

Masa depan dengan ResourceReponse.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

Mengirim aktivitas pelacakan ke BotAdapter untuk tujuan pengelogan.

Parameter:

turnContext - Konteks untuk giliran saat ini.

name - Nilai yang akan ditetapkan ke properti Activity#getName aktivitas.

value - Nilai yang akan ditetapkan ke properti Activity#getValue aktivitas.

valueType - Nilai yang akan ditetapkan ke properti Activity#getValueType aktivitas.

label - Nilai yang akan ditetapkan ke properti Activity#getLabel aktivitas.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan. Jika adaptor dihosting di Emulator, hasil tugas berisi objek ResourceResponse dengan ID aktivitas pelacakan asli; jika tidak, ini berisi objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas.

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

Menggantikan aktivitas yang ada.

Jika aktivitas berhasil dikirim, hasil tugas berisi objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas.

Sebelum memanggil ini, atur ID aktivitas penggantian ke ID aktivitas untuk diganti.

Parameter:

withActivity - Aktivitas penggantian baru.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.