botbuilder package

Kelas

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase	ChannelServiceHandlerBase mengimplementasikan API untuk meneruskan aktivitas ke keterampilan dan menerapkan panggilan ChannelAPI perutean dari Keterampilan melalui bot/adaptor.
ChannelServiceRoutes	Merutekan panggilan API dengan metode ChannelServiceHandler.
CloudAdapter	Adaptor yang mengimplementasikan Protokol Kerangka Kerja Bot dan dapat dihosting di lingkungan cloud yang berbeda baik publik maupun privat.
CloudChannelServiceHandler	Kelas untuk membantu implementasi protokol Bot Framework menggunakan BotFrameworkAuthentication.
EventFactory	Berisi metode utilitas untuk membuat berbagai jenis peristiwa.
FileTranscriptStore	Penyimpanan transkrip file menyimpan transkrip dalam sistem file dengan setiap aktivitas sebagai file.
HandoffEventNames	Menentukan nilai untuk nama peristiwa handoff.
InspectionMiddleware	InspectionMiddleware untuk pemeriksaan emulator aktivitas runtime dan BotState.
InspectionState	InspectionState untuk digunakan oleh InspectionMiddleware untuk inspeksi emulator aktivitas runtime dan BotState.
RouteConstants	Konstanta yang mewakili jalur API yang segera mengikuti basePath. Ini saat ini bersifat internal tetapi kami akan mengevaluasi kembali menjadikannya publik, di masa depan. Contoh RouteConstants.Activities = '/v3/conversations/:conversationId/activities'.
SetSpeakMiddleware	Dukung saluran ucapan dan telepon DirectLine untuk memastikan tag SSML yang sesuai diatur pada properti Activity Speak.
CloudSkillHandler	Handler Kerangka Kerja Bot untuk keterampilan.
SkillHandler
SkillHandlerImpl
SkillHttpClient	BotFrameworkHttpClient khusus untuk Keterampilan yang merangkum pembuatan ID Percakapan.
StatusCodeError	Memperluas Kesalahan untuk menyediakan pesan kesalahan khusus.
StreamingHttpClient	Implementasi HttpClient yang menambahkan kompatibilitas dengan koneksi streaming.
TokenResolver	Mencari OAuthCards dalam Lampiran aktivitas dan mengambil tindakan pada lampiran tersebut
TeamsSSOTokenExchangeMiddleware	Jika nama aktivitas masuk/tokenExchange, middleware ini akan mencoba menukar token, dan mendeduplikasi panggilan masuk, memastikan hanya satu permintaan pertukaran yang diproses. Jika pengguna masuk ke beberapa klien Teams, Bot dapat menerima "signin/tokenExchange" dari setiap klien. Setiap permintaan pertukaran token untuk login pengguna tertentu akan memiliki activity.value.id yang identik. Hanya salah satu permintaan pertukaran token ini yang harus diproses oleh bot. Yang lain mengembalikan StatusCodes.PRECONDITION_FAILED. Untuk bot terdistribusi dalam produksi, ini memerlukan penyimpanan terdistribusi yang memastikan hanya satu pertukaran token yang diproses. Middleware ini mendukung penyimpanan CosmosDb yang ditemukan di botbuilder-azure, atau MemoryStorage untuk pengembangan lokal.
TeamsActivityHandler	Menambahkan dukungan untuk peristiwa dan interaksi tertentu Microsoft Teams.
TeamsInfo	Menyediakan metode utilitas untuk peristiwa dan interaksi yang terjadi dalam Microsoft Teams.

Antarmuka

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer	Antarmuka yang mewakili Aplikasi Ekspres atau Server Restify.
ConnectorClientBuilder	Abstraksi untuk membangun klien konektor.
Request	Mewakili Permintaan HTTP Node.js, termasuk kumpulan properti penggunaan minimal. Kompatibel dengan Restify, Express, dan Node.js core http.
Response
WebRequest	Mewakili objek permintaan Ekspres atau Restify. Antarmuka ini mendukung kerangka kerja dan tidak dimaksudkan untuk dipanggil langsung untuk kode Anda.
WebResponse	Mewakili objek respons Ekspres atau Restify. Antarmuka ini mendukung kerangka kerja dan tidak dimaksudkan untuk dipanggil langsung untuk kode Anda.

Alias Jenis

RouteHandler

Fungsi

validateAndFixActivity(Activity)	Memvalidasi Aktivitas dan memformat bidang tanda waktu.
teamsGetChannelId(Activity)	Metode pembantu aktivitas untuk Teams.
teamsGetSelectedChannelId(Activity)	Mendapatkan id saluran yang dipilih Tim dari aktivitas saat ini.
teamsGetTeamId(Activity)	Mendapatkan Id Tim dariAktivitas saat ini .
teamsGetTeamInfo(Activity)	Mendapatkan objek TeamsInfo dariAktivitas saat ini.
teamsGetTeamMeetingInfo(Activity)	Mendapatkan objek TeamsMeetingInfo dariAktivitas saat ini.
teamsGetTenant(Activity)	Mendapatkan objek TenantInfo dariAktivitas saat ini .
teamsNotifyUser(Partial<Activity>, boolean, string)	Mengonfigurasi Aktivitas saat ini untuk menghasilkan pemberitahuan dalam Teams.

Detail Fungsi

validateAndFixActivity(Activity)

Memvalidasi Aktivitas dan memformat bidang tanda waktu.

function validateAndFixActivity(activity: Activity): Activity

Parameter

activity

Activity

(xref:botbuilder-core. Aktivitas) untuk divalidasi.

Mengembalikan

Activity

Aktivitas .

teamsGetChannelId(Activity)

Metode pembantu aktivitas untuk Teams.

function teamsGetChannelId(activity: Activity): string | null

Parameter

activity

Activity

Aktivitas saat ini .

Mengembalikan

string | null

Aktivitas saat iniid saluran tim, atau null.

teamsGetSelectedChannelId(Activity)

Mendapatkan id saluran yang dipilih Tim dari aktivitas saat ini.

function teamsGetSelectedChannelId(activity: Activity): string

Parameter

activity

Activity

Aktivitas saat ini .

Mengembalikan

string

Saluran yang dipilih tim aktivitas saat ini, atau string kosong.

teamsGetTeamId(Activity)

Mendapatkan Id Tim dariAktivitas saat ini .

function teamsGetTeamId(activity: Activity): string | null

Parameter

activity

Activity

Aktivitas saat ini .

Mengembalikan

string | null

Id tim Activitysaat ini, atau null.

teamsGetTeamInfo(Activity)

Mendapatkan objek TeamsInfo dariAktivitas saat ini.

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

Parameter

activity

Activity

Aktivitas saat ini .

Mengembalikan

TeamInfo | null

Info timAktivitas saat ini, atau null.

teamsGetTeamMeetingInfo(Activity)

Mendapatkan objek TeamsMeetingInfo dariAktivitas saat ini.

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

Parameter

activity

Activity

Aktivitas saat ini .

Mengembalikan

TeamsMeetingInfo | null

Info rapat timAktivitas saat ini, atau null.

teamsGetTenant(Activity)

Mendapatkan objek TenantInfo dariAktivitas saat ini .

function teamsGetTenant(activity: Activity): TenantInfo | null

Parameter

activity

Activity

Aktivitas saat ini .

Mengembalikan

TenantInfo | null

Info penyewaAktivitas saat ini, atau null.

teamsNotifyUser(Partial<Activity>, boolean, string)

Mengonfigurasi Aktivitas saat ini untuk menghasilkan pemberitahuan dalam Teams.

function teamsNotifyUser(activity: Partial<Activity>, alertInMeeting?: boolean, externalResourceUrl?: string)

Parameter

activity

Partial<Activity>

Aktivitas saat ini .

alertInMeeting

boolean

Dikirim ke obrolan rapat, ini akan menyebabkan klien Teams merendernya dalam popup pemberitahuan serta di utas obrolan.

externalResourceUrl

string

Url ke sumber daya eksternal. Harus disertakan dalam domain manifes yang valid.