ConfigurationBotFrameworkAuthentication class

包:

botbuilder-core

使用身份验证值或配置实例从对象创建 BotFrameworkAuthentication 实例。

扩展

BotFrameworkAuthentication

构造函数

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

初始化 ConfigurationBotFrameworkAuthentication 类的新实例。

方法

authenticateChannelRequest(string)	对 Skills 的 Bot Framework 协议请求进行身份验证。
authenticateRequest(Activity, string)	验证 Bot Framework 协议请求。
authenticateStreamingRequest(string, string)	验证 Bot Framework 协议请求。
createBotFrameworkClient()	创建 BotFrameworkClient 用于调用 Skills。
createConnectorFactory(ClaimsIdentity)	创建一个 ConnectorFactory，该连接器工厂可用于创建可以使用此特定云环境中的凭据的 ConnectorClient。
createUserTokenClient(ClaimsIdentity)	创建相应的 UserTokenClient 实例。

继承的方法

getOriginatingAudience()

从 Bot OAuth 范围获取原始受众。

构造函数详细信息

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

初始化 ConfigurationBotFrameworkAuthentication 类的新实例。

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

参数

botFrameworkAuthConfig

ConfigurationBotFrameworkAuthenticationOptions

ConfigurationBotFrameworkAuthenticationOptions 对象。

credentialsFactory

ServiceClientCredentialsFactory

ServiceClientCredentialsFactory 实例。

authConfiguration

AuthenticationConfiguration

Configuration 对象。

botFrameworkClientFetch

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

要用于 BotFrameworkClient 的自定义提取实现。

connectorClientOptions

ConnectorClientOptions

ConnectorClientOptions 对象。

方法详细信息

authenticateChannelRequest(string)

对 Skills 的 Bot Framework 协议请求进行身份验证。

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

参数

authHeader

string

技能请求中收到的 http 身份验证标头。

返回

Promise<ClaimsIdentity>

ClaimsIdentity。

authenticateRequest(Activity, string)

验证 Bot Framework 协议请求。

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

参数

activity

Activity

入站活动。

authHeader

string

HTTP 身份验证标头。

返回

Promise<AuthenticateRequestResult>

AuthenticateRequestResult。

authenticateStreamingRequest(string, string)

验证 Bot Framework 协议请求。

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

参数

authHeader

string

HTTP 身份验证标头。

channelIdHeader

string

通道 ID HTTP 标头。

返回

Promise<AuthenticateRequestResult>

AuthenticateRequestResult。

createBotFrameworkClient()

创建 BotFrameworkClient 用于调用 Skills。

function createBotFrameworkClient(): BotFrameworkClient

返回

BotFrameworkClient

BotFrameworkClient。

createConnectorFactory(ClaimsIdentity)

创建一个 ConnectorFactory，该连接器工厂可用于创建可以使用此特定云环境中的凭据的 ConnectorClient。

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

参数

claimsIdentity

ClaimsIdentity

入站活动的 ClaimsIdentity。

返回

ConnectorFactory

ConnectorFactory。

createUserTokenClient(ClaimsIdentity)

创建相应的 UserTokenClient 实例。

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

参数

claimsIdentity

ClaimsIdentity

入站活动的 ClaimsIdentity。

返回

Promise<UserTokenClient>

UserTokenClient。

继承的方法详细信息

getOriginatingAudience()

从 Bot OAuth 范围获取原始受众。

function getOriginatingAudience(): string

返回

string

发起受众。

继承自 BotFrameworkAuthentication.getOriginatingAudience