BotFrameworkAdapter Kelas

Referensi

Definisi

Ruang nama:: Microsoft.Bot.Builder

Rakitan:: Microsoft.Bot.Builder.dll

Paket:: Microsoft.Bot.Builder v4.22.7

Penting

Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.

Adaptor bot yang dapat menyambungkan bot ke titik akhir layanan.

public class BotFrameworkAdapter : Microsoft.Bot.Builder.BotAdapter, Microsoft.Bot.Builder.IExtendedUserTokenProvider, Microsoft.Bot.Builder.Integration.IAdapterIntegration, Microsoft.Bot.Builder.OAuth.IConnectorClientBuilder

type BotFrameworkAdapter = class
    inherit BotAdapter
    interface IAdapterIntegration
    interface IExtendedUserTokenProvider
    interface IUserTokenProvider
    interface IConnectorClientBuilder

Public Class BotFrameworkAdapter
Inherits BotAdapter
Implements IAdapterIntegration, IConnectorClientBuilder, IExtendedUserTokenProvider

Warisan: Object

BotAdapter
BotFrameworkAdapter

Turunan: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Penerapan: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Keterangan

BotFrameworkAdapter masih didukung tetapi adaptor yang direkomendasikan adalah 'CloudAdapter'. 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(IMiddleware) untuk menambahkan objek IMiddleware ke koleksi middleware adapter Anda. Adaptor memproses dan mengarahkan aktivitas masuk melalui alur middleware bot ke logika bot 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.

Konstruktor

BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Menginisialisasi instans baru kelas BotFrameworkAdapter, menggunakan penyedia info masuk.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Menginisialisasi instans baru kelas BotFrameworkAdapter, menggunakan penyedia info masuk.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Menginisialisasi instans baru kelas BotFrameworkAdapter, menggunakan penyedia info masuk.

Bidang

BotIdentityKey	Nilai string untuk kunci identitas bot. (Diperoleh dari BotAdapter)
InvokeResponseKey	Nilai kunci untuk InvokeResponseActivity apa pun yang akan berada di TurnState. (Diperoleh dari BotAdapter)
OAuthScopeKey	Nilai string untuk kunci cakupan OAuth. (Diperoleh dari BotAdapter)

Properti

AppCredentialMap	Mendapatkan peta aplikasi untuk AppCredentials adaptor ini.
ChannelProvider	Mendapatkan penyedia saluran untuk adaptor ini.
CredentialProvider	Mendapatkan penyedia kredensial untuk adaptor ini.
HttpClient	Mendapatkan HttpClient kustom untuk adaptor ini jika ditentukan.
Logger	Mendapatkan pencatat untuk adaptor ini.
MiddlewareSet	Mendapatkan koleksi middleware di alur adaptor. (Diperoleh dari BotAdapter)
OnTurnError	Mendapatkan atau mengatur handler kesalahan yang dapat menangkap pengecualian di middleware atau aplikasi. (Diperoleh dari BotAdapter)

Metode

BuildCredentialsAsync(String, String)	Logika untuk membangun objek AppCredentials yang akan digunakan untuk memperoleh token untuk HttpClient ini.
CanProcessOutgoingActivity(Activity)	Kesempatan bagi subkelas untuk ikut serta memproses aktivitas keluar.
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Mengirim pesan proaktif ke percakapan. (Diperoleh dari BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Mengirim pesan proaktif ke percakapan. (Diperoleh dari BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Mengirim pesan proaktif dari bot ke percakapan.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Mengirim pesan proaktif dari bot ke percakapan.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Mengirim pesan proaktif ke percakapan. (Diperoleh dari BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Mengirim pesan proaktif dari bot ke percakapan.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Membuat percakapan pada saluran yang ditentukan.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Kedaluwarsa. Membuat percakapan pada saluran yang ditentukan. Kelebihan beban menerima ConversationReference termasuk penyewa.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Membuat percakapan pada saluran yang ditentukan.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Kedaluwarsa. Membuat percakapan pada saluran yang ditentukan. Kelebihan beban menerima ConversationReference termasuk penyewa.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Membuat percakapan pada saluran yang ditentukan. (Diperoleh dari BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Membuat klien OAuth untuk bot.
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Membuat klien OAuth untuk bot dengan kredensial.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Menghapus aktivitas yang sudah ada dalam percakapan.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Menghapus anggota dari percakapan saat ini.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Melakukan operasi pertukaran token seperti untuk akses menyeluruh.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Melakukan operasi pertukaran token seperti untuk akses menyeluruh.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Mengambil token Azure Active Directory untuk sumber daya tertentu pada koneksi yang dikonfigurasi, menggunakan AppCredentials yang disesuaikan.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Mengambil token Azure Active Directory untuk sumber daya tertentu pada koneksi yang dikonfigurasi, menggunakan AppCredentials bot.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Mencantumkan anggota aktivitas tertentu.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Mencantumkan anggota percakapan saat ini.
GetConversationsAsync(ITurnContext, String, CancellationToken)	Mencantumkan Percakapan di mana bot ini telah berpartisipasi untuk server saluran tertentu. Server saluran mengembalikan hasil di halaman dan setiap halaman akan menyertakan `continuationToken` yang dapat digunakan untuk mengambil halaman hasil berikutnya dari server.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Mencantumkan Percakapan di mana bot ini telah berpartisipasi untuk server saluran tertentu. Server saluran mengembalikan hasil di halaman dan setiap halaman akan menyertakan `continuationToken` yang dapat digunakan untuk mengambil halaman hasil berikutnya dari server.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi, menggunakan AppCredentials yang disesuaikan.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi, menggunakan AppCredentials yang disesuaikan.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi, menggunakan AppCredentials bot.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi, menggunakan AppCredentials bot.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi.
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Mengambil status token untuk setiap koneksi yang dikonfigurasi untuk pengguna tertentu, menggunakan AppCredentials yang disesuaikan.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Mengambil status token untuk setiap koneksi yang dikonfigurasi untuk pengguna tertentu, menggunakan AppCredentials bot.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Mencoba mengambil token untuk pengguna yang berada dalam alur masuk, menggunakan AppCredentials yang disesuaikan.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Mencoba mengambil token untuk pengguna yang berada dalam alur masuk, menggunakan AppCredentials bot.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Membuat konteks giliran dan menjalankan alur middleware untuk aktivitas masuk.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Membuat konteks giliran dan menjalankan alur middleware untuk aktivitas masuk.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Logika kustom untuk mengirim aktivitas keluar. Subkelas dapat mengambil alih metode ini bersama dengan CanProcessOutgoingActivity untuk memiliki logika kustom untuk memproses aktivitas keluar.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Memulai pemrosesan aktivitas untuk giliran bot saat ini. (Diperoleh dari BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Mengirim aktivitas ke percakapan.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Mengeluarkan pengguna dengan server token, menggunakan AppCredentials yang disesuaikan.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Mengeluarkan pengguna dengan server token, menggunakan AppCredentials bot.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Menggantikan aktivitas yang sudah ada dalam percakapan.
Use(IMiddleware)	Menambahkan middleware ke alur adaptor.

Implementasi Antarmuka Eksplisit

IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)