CloudAdapter class

Referensi

Paket:: botbuilder

Adaptor yang mengimplementasikan Protokol Kerangka Kerja Bot dan dapat dihosting di lingkungan cloud yang berbeda baik publik maupun privat.

Memperluas: CloudAdapterBase

Konstruktor

CloudAdapter(BotFrameworkAuthentication)

Menginisialisasi instans baru kelas CloudAdapter.

Properti yang Diwariskan

BotIdentityKey
ConnectorClientKey
ConnectorFactoryKey
OAuthScopeKey
onTurnError
UserTokenClientKey

Metode

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)	Digunakan untuk menyambungkan adaptor ke pipa bernama.
process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)	Tangani koneksi soket web dengan menerapkan fungsi logika ke setiap permintaan streaming.
process(Request, Response, (context: TurnContext) => Promise<void>)	Proses permintaan web dengan menerapkan fungsi logika.

Metode yang Diwarisi

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)
continueConversationAsync(string \| ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> \| string, (context: TurnContext) => Promise<void>)
createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>)
deleteActivity(TurnContext, Partial<ConversationReference>)
sendActivities(TurnContext, Partial<Activity>[])
updateActivity(TurnContext, Partial<Activity>)
use((context: TurnContext, next: () => Promise<void>) => Promise<void> \| Middleware[])	Menambahkan middleware ke alur adaptor.

Detail Konstruktor

CloudAdapter(BotFrameworkAuthentication)

Menginisialisasi instans baru kelas CloudAdapter.

new CloudAdapter(botFrameworkAuthentication?: BotFrameworkAuthentication)

Parameter

botFrameworkAuthentication: BotFrameworkAuthentication

Instans BotFrameworkAuthentication opsional

Detail Properti yang Diwariskan

BotIdentityKey

BotIdentityKey: symbol

Nilai Properti

symbol

Diwariskan Dari BotAdapter.BotIdentityKey

ConnectorClientKey

ConnectorClientKey: symbol

Nilai Properti

symbol

Diwariskan Dari BotAdapter.ConnectorClientKey

ConnectorFactoryKey

ConnectorFactoryKey: symbol

Nilai Properti

symbol

Diwarisi Dari CloudAdapterBase.ConnectorFactoryKey

OAuthScopeKey

OAuthScopeKey: symbol

Nilai Properti

symbol

Diwariskan Dari BotAdapter.OAuthScopeKey

onTurnError

onTurnError: (context: TurnContext, error: Error) => Promise<void>

Nilai Properti

(context: TurnContext, error: Error) => Promise<void>

Diwariskan Dari BotAdapter.onTurnError

UserTokenClientKey

UserTokenClientKey: symbol

Nilai Properti

symbol

Diwarisi Dari CloudAdapterBase.UserTokenClientKey

Detail Metode

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

Digunakan untuk menyambungkan adaptor ke pipa bernama.

function connectNamedPipe(pipeName: string, logic: (context: TurnContext) => Promise<void>, appId: string, audience: string, callerId?: string, retryCount?: number): Promise<void>

Parameter

pipeName: string

Nama pipa untuk disambungkan (catatan: menghasilkan dua server pipa bernama dengan menambahkan ".incoming" dan ".outgoing" ke nama ini)

logic: (context: TurnContext) => Promise<void>

Fungsi logika yang akan dipanggil untuk menghasilkan bot berubah.

appId: string

ID aplikasi Bot

audience: string

Audiens yang digunakan untuk komunikasi keluar. Akan bervariasi menurut lingkungan cloud.

callerId: string

Opsional, ID penelepon

retryCount: number

Opsional, berapa kali untuk mencoba kembali koneksi yang gagal (default ke 7)

Mengembalikan

Promise<void>

process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Tangani koneksi soket web dengan menerapkan fungsi logika ke setiap permintaan streaming.

function process(req: Request, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parameter

req: Request

Permintaan HTTP masuk

socket: INodeSocket

INodeSocket yang sesuai

head: INodeBuffer

INodeBuffer yang sesuai

logic: (context: TurnContext) => Promise<void>

Fungsi logika yang akan diterapkan

Mengembalikan

Promise<void>

janji yang mewakili operasi asinkron.

process(Request, Response, (context: TurnContext) => Promise<void>)

Proses permintaan web dengan menerapkan fungsi logika.

function process(req: Request, res: Response, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parameter

req: Request

Respons HTTP yang sesuai

res: Response

logic: (context: TurnContext) => Promise<void>

Fungsi logika yang akan diterapkan

Mengembalikan

Promise<void>

janji yang mewakili operasi asinkron.

Detail Metode yang Diwarisi

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)

Peringatan

API ini sudah tidak digunakan lagi.

function continueConversation(_reference: Partial<ConversationReference>, _logic: (context: TurnContext) => Promise<void>): Promise<void>

Parameter

_reference: Partial<ConversationReference>

_logic: (context: TurnContext) => Promise<void>

Mengembalikan

Promise<void>

Diwarisi Dari CloudAdapterBase.continueConversation

continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>)

function continueConversationAsync(botAppIdOrClaimsIdentity: string | ClaimsIdentity, reference: Partial<ConversationReference>, logicOrAudience: (context: TurnContext) => Promise<void> | string, maybeLogic?: (context: TurnContext) => Promise<void>): Promise<void>

Parameter

botAppIdOrClaimsIdentity: string | ClaimsIdentity

reference: Partial<ConversationReference>

logicOrAudience: (context: TurnContext) => Promise<void> | string

maybeLogic: (context: TurnContext) => Promise<void>

Mengembalikan

Promise<void>

Diwarisi Dari CloudAdapterBase.continueConversationAsync

createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>)

function createConversationAsync(botAppId: string, channelId: string, serviceUrl: string, audience: string, conversationParameters: ConversationParameters, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parameter

botAppId: string

channelId: string

serviceUrl: string

audience: string

conversationParameters: ConversationParameters

logic: (context: TurnContext) => Promise<void>

Mengembalikan

Promise<void>

Diwariskan Dari CloudAdapterBase.createConversationAsync

deleteActivity(TurnContext, Partial<ConversationReference>)

function deleteActivity(context: TurnContext, reference: Partial<ConversationReference>): Promise<void>

Parameter

context: TurnContext

reference: Partial<ConversationReference>

Mengembalikan

Promise<void>

Diwariskan Dari CloudAdapterBase.deleteActivity

sendActivities(TurnContext, Partial<Activity>[])

function sendActivities(context: TurnContext, activities: Partial<Activity>[]): Promise<ResourceResponse[]>

Parameter

context: TurnContext

activities: Partial<Activity>[]

Mengembalikan

Promise<ResourceResponse[]>

Diwariskan Dari CloudAdapterBase.sendActivities

updateActivity(TurnContext, Partial<Activity>)

function updateActivity(context: TurnContext, activity: Partial<Activity>): Promise<ResourceResponse | void>

Parameter

context: TurnContext

activity: Partial<Activity>

Mengembalikan

Promise<ResourceResponse | void>

Diwariskan Dari CloudAdapterBase.updateActivity

use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

Menambahkan middleware ke alur adaptor.

function use(middlewares: (context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]): this

Parameter

middlewares: (context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]

Penghandel middleware atau middleware yang akan ditambahkan.

Mengembalikan

this

Objek adapter yang diperbarui.

Keterangan

Middleware ditambahkan ke adaptor pada waktu inisialisasi. Setiap giliran, adaptor memanggil middleware-nya dalam urutan Anda menambahkannya.

Diwariskan Dari BotAdapter.use