ConfigurationBotFrameworkAuthentication class

Referensi

Paket:: botbuilder-core

Membuat instans BotFrameworkAuthentication dari objek dengan nilai autentikasi atau instans Konfigurasi .

Memperluas: BotFrameworkAuthentication

Konstruktor

ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Menginisialisasi instans baru kelas ConfigurationBotFrameworkAuthentication.

Metode

authenticateChannelRequest(string)	Mengautentikasi permintaan Protokol Kerangka Kerja Bot ke Keterampilan.
authenticateRequest(Activity, string)	Memvalidasi permintaan Protokol Kerangka Kerja Bot.
authenticateStreamingRequest(string, string)	Memvalidasi permintaan Protokol Kerangka Kerja Bot.
createBotFrameworkClient()	Membuat BotFrameworkClient untuk memanggil Keterampilan.
createConnectorFactory(ClaimsIdentity)	Membuat ConnectorFactory yang dapat digunakan untuk membuat ConnectorClients yang dapat menggunakan kredensial dari Lingkungan Cloud khusus ini.
createUserTokenClient(ClaimsIdentity)	Membuat instans UserTokenClient yang sesuai.

Metode yang Diwarisi

getOriginatingAudience()

Mendapatkan audiens asal dari cakupan Bot OAuth.

Detail Konstruktor

ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Menginisialisasi instans baru kelas ConfigurationBotFrameworkAuthentication.

new ConfigurationBotFrameworkAuthentication(botFrameworkAuthConfig?: ConfigurationBotFrameworkAuthenticationOptions, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)

Parameter

botFrameworkAuthConfig: ConfigurationBotFrameworkAuthenticationOptions

Objek ConfigurationBotFrameworkAuthenticationOptions .

credentialsFactory: ServiceClientCredentialsFactory

Instans ServiceClientCredentialsFactory.

authConfiguration: AuthenticationConfiguration

Objek Konfigurasi .

botFrameworkClientFetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>

Implementasi Fetch kustom yang akan digunakan dalam BotFrameworkClient.

connectorClientOptions: ConnectorClientOptions

Objek ConnectorClientOptions.

Detail Metode

authenticateChannelRequest(string)

Mengautentikasi permintaan Protokol Kerangka Kerja Bot ke Keterampilan.

function authenticateChannelRequest(authHeader: string): Promise<ClaimsIdentity>

Parameter

authHeader: string

Header autentikasi http diterima dalam permintaan keterampilan.

Mengembalikan

Promise<ClaimsIdentity>

ClaimsIdentity .

authenticateRequest(Activity, string)

Memvalidasi permintaan Protokol Kerangka Kerja Bot.

function authenticateRequest(activity: Activity, authHeader: string): Promise<AuthenticateRequestResult>

Parameter

activity: Activity

Aktivitas masuk.

authHeader: string

Header autentikasi HTTP.

Mengembalikan

Promise<AuthenticateRequestResult>

AuthenticateRequestResult.

authenticateStreamingRequest(string, string)

Memvalidasi permintaan Protokol Kerangka Kerja Bot.

function authenticateStreamingRequest(authHeader: string, channelIdHeader: string): Promise<AuthenticateRequestResult>

Parameter

authHeader: string

Header autentikasi HTTP.

channelIdHeader: string

Header HTTP ID saluran.

Mengembalikan

Promise<AuthenticateRequestResult>

AuthenticateRequestResult.

createBotFrameworkClient()

Membuat BotFrameworkClient untuk memanggil Keterampilan.

function createBotFrameworkClient(): BotFrameworkClient

Mengembalikan

BotFrameworkClient

BotFrameworkClient.

createConnectorFactory(ClaimsIdentity)

Membuat ConnectorFactory yang dapat digunakan untuk membuat ConnectorClients yang dapat menggunakan kredensial dari Lingkungan Cloud khusus ini.

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

Parameter

claimsIdentity: ClaimsIdentity

ClaimsIdentity Aktivitas masuk.

Mengembalikan

ConnectorFactory

ConnectorFactory.

createUserTokenClient(ClaimsIdentity)

Membuat instans UserTokenClient yang sesuai.

function createUserTokenClient(claimsIdentity: ClaimsIdentity): Promise<UserTokenClient>

Parameter

claimsIdentity: ClaimsIdentity

ClaimsIdentity Aktivitas masuk.

Mengembalikan

Promise<UserTokenClient>

UserTokenClient .

Detail Metode yang Diwarisi

getOriginatingAudience()

Mendapatkan audiens asal dari cakupan Bot OAuth.

function getOriginatingAudience(): string

Mengembalikan

string

Audiens asal.

Diwariskan Dari BotFrameworkAuthentication.getOriginatingAudience