ParameterizedBotFrameworkAuthentication class

扩展

构造函数

ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

方法

authenticateChannelRequest(string)
authenticateRequest(Activity, string)

验证 Bot Framework 协议请求。

authenticateStreamingRequest(string, string)

验证 Bot Framework 协议请求。

createBotFrameworkClient()

创建用于调用 Skills 的 BotFrameworkClient。

createConnectorFactory(ClaimsIdentity)

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

createUserTokenClient(ClaimsIdentity)

创建相应的 UserTokenClient 实例。

getOriginatingAudience()

获取来自 Bot OAuth 范围的发起受众。

构造函数详细信息

ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

new ParameterizedBotFrameworkAuthentication(validateAuthority: boolean, toChannelFromBotLoginUrl: string, toChannelFromBotOAuthScope: string, toBotFromChannelTokenIssuer: string, oAuthUrl: string, toBotFromChannelOpenIdMetadataUrl: string, toBotFromEmulatorOpenIdMetadataUrl: string, callerId: string, credentialsFactory: ServiceClientCredentialsFactory, authConfiguration: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)

参数

validateAuthority

boolean

要使用的验证颁发机构值。

toChannelFromBotLoginUrl

string

从机器人登录 URL 到通道。

toChannelFromBotOAuthScope

string

来自机器人 oauth 范围的到通道。

toBotFromChannelTokenIssuer

string

来自通道令牌颁发者的机器人。

oAuthUrl

string

OAuth URL。

toBotFromChannelOpenIdMetadataUrl

string

通道开放 ID 元数据 URL 中的到机器人。

toBotFromEmulatorOpenIdMetadataUrl

string

从模拟器打开 ID 元数据 URL 到机器人。

callerId

string

对经过身份验证 活动设置的 callerId。

credentialsFactory
ServiceClientCredentialsFactory

用于创建凭据的 ServiceClientCredentialsFactory

authConfiguration
AuthenticationConfiguration

要使用的 AuthenticationConfiguration

botFrameworkClientFetch

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

要用于 BotFrameworkClient 的提取。

connectorClientOptions
ConnectorClientOptions

创建 ConnectorClients 时要使用的 ConnectorClientOptions

方法详细信息

authenticateChannelRequest(string)

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

参数

authHeader

string

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

返回

Promise<ClaimsIdentity>

标识验证结果。

authenticateRequest(Activity, string)

验证 Bot Framework 协议请求。

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

参数

activity

Activity

入站活动。

authHeader

string

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

返回

Promise with AuthenticateRequestResult.

authenticateStreamingRequest(string, string)

验证 Bot Framework 协议请求。

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

参数

authHeader

string

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

channelIdHeader

string

通道 ID HTTP 标头。

返回

Promise with AuthenticateRequestResult.

createBotFrameworkClient()

创建用于调用 Skills 的 BotFrameworkClient。

function createBotFrameworkClient(): BotFrameworkClient

返回

用于调用 Skills 的 BotFrameworkClient 实例。

createConnectorFactory(ClaimsIdentity)

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

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

参数

claimsIdentity
ClaimsIdentity

入站活动的 ClaimsIdentity。

返回

ConnectorFactory。

createUserTokenClient(ClaimsIdentity)

创建相应的 UserTokenClient 实例。

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

参数

claimsIdentity
ClaimsIdentity

入站活动的 ClaimsIdentity。

返回

Promise<UserTokenClient>

具有 UserTokenClient 实例的 Promise。

getOriginatingAudience()

获取来自 Bot OAuth 范围的发起受众。

function getOriginatingAudience(): string

返回

string

原始受众。