BotAdapter Kelas

Referensi

Paket:: com.microsoft.bot.builder

Maven Artifact:: com.microsoft.bot:bot-builder:4.14.3

java.lang.Object
- com.microsoft.bot.builder.BotAdapter

public abstract class BotAdapter

Mewakili adaptor bot yang dapat menyambungkan bot ke titik akhir layanan. Kelas ini abstrak.

Adaptor bot merangkum proses autentikasi dan mengirim aktivitas ke dan menerima aktivitas dari Bot Connector Service. Saat bot Anda menerima aktivitas, adaptor membuat objek konteks, meneruskannya ke logika aplikasi bot Anda, dan mengirim respons kembali ke saluran pengguna.

Gunakan use(Middleware middleware) untuk menambahkan objek Middleware ke koleksi middleware\u2019adaptor Anda. Adaptor memproses dan mengarahkan aktivitas masuk melalui alur middleware bot ke logika\u2019bot Anda dan kemudian kembali keluar lagi. Saat setiap aktivitas mengalir masuk dan keluar dari bot, setiap bagian middleware dapat memeriksa atau bertindak berdasarkan aktivitas, baik sebelum dan sesudah logika bot berjalan.

TurnContext Activity Bot Middleware

Ringkasan Bidang

Pemodifikasi dan Jenis	Bidang dan Deskripsi
static final java.lang.String	BOT_IDENTITY_KEY Kunci untuk menyimpan identitas klaim bot.
static final java.lang.String	OAUTH_CLIENT_KEY Kunci untuk menyimpan klien oauth bot.
static final java.lang.String	OAUTH_SCOPE_KEY Kunci untuk menyimpan cakupan oauth bot.

Ringkasan Konstruktor

Konstruktor	Deskripsi
BotAdapter()

Ringkasan Metode

Pemodifikasi dan Jenis	Metode dan Deskripsi
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback) Mengirim pesan proaktif ke percakapan.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback) Mengirim pesan proaktif ke percakapan.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback) Mengirim pesan proaktif ke percakapan.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback) Mengirim pesan proaktif ke percakapan.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback) Mengirim pesan proaktif ke percakapan.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) Mengirim pesan proaktif ke percakapan.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(TurnContext context, ConversationReference reference) Saat ditimpa di kelas turunan, menghapus aktivitas yang ada dalam percakapan.
protected MiddlewareSet	getMiddlewareSet() Mendapatkan koleksi middleware di alur adaptor.
OnTurnErrorHandler	getOnTurnError() Mendapatkan handler kesalahan yang dapat menangkap pengecualian di middleware atau aplikasi.
protected java.util.concurrent.CompletableFuture<java.lang.Void>	runPipeline(TurnContext context, BotCallbackHandler callback) Memulai pemrosesan aktivitas untuk giliran bot saat ini.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(TurnContext context, List<Activity> activities) Ketika ditimpa di kelas turunan, mengirim aktivitas ke percakapan.
void	setOnTurnError(OnTurnErrorHandler withTurnError) Mengatur handler kesalahan yang dapat menangkap pengecualian di middleware atau aplikasi.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(TurnContext context, Activity activity) Saat ditimpa di kelas turunan, menggantikan aktivitas yang ada dalam percakapan.
BotAdapter	use(Middleware middleware) Menambahkan middleware ke alur adaptor.

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

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

Kunci untuk menyimpan identitas klaim bot.

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

Kunci untuk menyimpan klien oauth bot.

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

Kunci untuk menyimpan cakupan oauth bot.

Detail Konstruktor

BotAdapter

public BotAdapter()

Detail Metode

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Mengirim pesan proaktif ke percakapan.

Panggil metode ini untuk mengirim pesan secara proaktif ke percakapan. Sebagian besar saluran mengharuskan pengguna untuk memulai percakapan dengan bot sebelum bot dapat mengirim aktivitas kepada pengguna.

Parameter:

claimsIdentity - ClaimsIdentity untuk percakapan.

continuationActivity - Aktivitas dengan ConversationReference yang sesuai untuk melanjutkan percakapan.

callback - Metode untuk memanggil giliran bot hasil.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Mengirim pesan proaktif ke percakapan.

Parameter:

claimsIdentity - ClaimsIdentity untuk percakapan.

continuationActivity - Aktivitas dengan ConversationReference yang sesuai untuk melanjutkan percakapan.

audience - Nilai yang menandakan penerima pesan proaktif.

callback - Metode untuk memanggil giliran bot hasil.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Mengirim pesan proaktif ke percakapan.

Parameter:

claimsIdentity - Referensi ClaimsIdentity untuk percakapan.

reference - Referensi ke percakapan untuk melanjutkan.

callback - Metode untuk memanggil giliran bot hasil.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Mengirim pesan proaktif ke percakapan.

Parameter:

claimsIdentity - Referensi ClaimsIdentity untuk percakapan.

reference - Referensi ke percakapan untuk melanjutkan.

audience - Nilai yang menandakan penerima pesan proaktif.

callback - Metode untuk memanggil giliran bot hasil.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Mengirim pesan proaktif ke percakapan.

Parameter:

botId - ID aplikasi bot. Parameter ini diabaikan dalam penyewa tunggal Adapter (Konsol, Pengujian, dll) tetapi sangat penting untuk BotFrameworkAdapter yang sadar multi-penyewa.

continuationActivity - Aktivitas dengan ConversationReference yang sesuai untuk melanjutkan percakapan.

callback - Metode untuk memanggil giliran bot hasil.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Mengirim pesan proaktif ke percakapan.

Parameter:

botAppId - ID aplikasi bot. Parameter ini diabaikan dalam penyewa tunggal Adapter (Konsol, Pengujian, dll) tetapi sangat penting untuk BotFrameworkAdapter yang sadar multi-penyewa.

reference - Referensi ke percakapan untuk melanjutkan.

callback - Metode untuk memanggil giliran bot yang dihasilkan.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan. Panggil metode ini untuk mengirim pesan secara proaktif ke percakapan. Sebagian besar saluran mengharuskan pengguna untuk memulai percakapan dengan bot sebelum bot dapat mengirim aktivitas kepada pengguna.

     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Saat ditimpa di kelas turunan, menghapus aktivitas yang ada dalam percakapan.

Parameter:

context - Objek konteks untuk giliran.

reference - Referensi percakapan untuk aktivitas yang akan dihapus.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan. ConversationReference#getActivityId referensi percakapan mengidentifikasi aktivitas yang akan dihapus. onDeleteActivity(DeleteActivityHandler handler)

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

Mendapatkan koleksi middleware di alur adaptor.

Mengembalikan:

Koleksi middleware untuk alur.

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

Mendapatkan handler kesalahan yang dapat menangkap pengecualian di middleware atau aplikasi.

Mengembalikan:

Handler kesalahan yang dapat menangkap pengecualian di middleware atau aplikasi.

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

Memulai pemrosesan aktivitas untuk giliran bot saat ini. Adaptor memanggil middleware dalam urutan Anda menambahkannya. Adaptor meneruskan objek konteks untuk giliran dan delegasi berikutnya, dan middleware memanggil delegasi untuk meneruskan kontrol ke middleware berikutnya di alur. Setelah kontrol mencapai akhir alur, adaptor memanggil metode callback. Jika komponen middleware tidak memanggil delegasi berikutnya, adaptor tidak memanggil salah satu middleware berikutnya\u2019metode onTurn(TurnContext turnContext, NextDelegate next) atau metode panggilan balik, dan sirkuit alur.

Ketika giliran dimulai oleh aktivitas pengguna (olahpesan reaktif), metode panggilan balik akan menjadi referensi ke metode onTurn(TurnContext turnContext) bot. Ketika giliran dimulai oleh panggilan ke continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) (olahpesan proaktif), metode panggilan balik adalah metode panggilan balik yang disediakan dalam panggilan.

Parameter:

context - Objek konteks giliran.

callback - Metode panggilan balik untuk dijalankan di akhir alur.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan.

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

Ketika ditimpa di kelas turunan, mengirim aktivitas ke percakapan.

Parameter:

context - Objek konteks untuk giliran.

activities - Kegiatan yang akan dikirim.

Mengembalikan:

Tugas yang mewakili pekerjaan yang diantrekan untuk dijalankan. Jika aktivitas berhasil dikirim, hasil tugas berisi array objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas. onSendActivities(SendActivitiesHandler handler)

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

Mengatur handler kesalahan yang dapat menangkap pengecualian di middleware atau aplikasi.

Parameter:

withTurnError - Handler kesalahan yang dapat menangkap pengecualian di middleware atau aplikasi.

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

Saat ditimpa di kelas turunan, menggantikan aktivitas yang ada dalam percakapan.

Parameter:

context - Objek konteks untuk giliran.

activity - Aktivitas penggantian baru.

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.

Sebelum memanggil ini, atur ID aktivitas penggantian ke ID aktivitas untuk diganti. onUpdateActivity(UpdateActivityHandler handler)

use

public BotAdapter use(Middleware middleware)

Menambahkan middleware ke alur adaptor.

Parameter:

middleware - Middleware yang akan ditambahkan.

Mengembalikan:

Objek adapter yang diperbarui. Middleware ditambahkan ke adaptor pada waktu inisialisasi. Untuk setiap giliran, adaptor memanggil middleware dalam urutan Anda menambahkannya.

Bagikan melalui

BotAdapter Kelas

Ringkasan Bidang

Ringkasan Konstruktor

Ringkasan Metode

Metode diperoleh dari java.lang.Object

Detail Bidang

BOT_IDENTITY_KEY

OAUTH_CLIENT_KEY

OAUTH_SCOPE_KEY

Detail Konstruktor

BotAdapter

Detail Metode

continueConversation

continueConversation

continueConversation

continueConversation

continueConversation

continueConversation

deleteActivity

getMiddlewareSet

getOnTurnError

runPipeline

sendActivities

setOnTurnError

updateActivity

use

Berlaku untuk