AppCredentials class

包:

botframework-connector

常规 AppCredentials 身份验证实现和缓存。 支持任何 ADAL 客户端凭据流。 子类可以实现 refreshToken 来获取令牌。

构造函数

AppCredentials(string, string, string)

初始化 AppCredentials 类的新实例。

属性

appId
oAuthEndpoint	获取要使用的 OAuth 终结点。 设置要使用的 OAuth 终结点。
oAuthScope	获取要使用的 OAuth 范围。 设置要使用的 OAuth 范围。
tokenCacheKey

方法

getToken(boolean)	获取 OAuth 访问令牌。
isTrustedServiceUrl(string)	检查服务 URL 是否为受信任的主机。
signRequest(WebResource)	将凭据应用于 HTTP 请求。
trustServiceUrl(string, Date)	将服务 URL 的主机添加到受信任的主机。 如果未提供过期时间，则到期日期将为当前 （utc） 日期 + 1 天。

构造函数详细信息

AppCredentials(string, string, string)

初始化 AppCredentials 类的新实例。

new AppCredentials(appId: string, channelAuthTenant?: string, oAuthScope?: string)

参数

appId

string

应用 ID。

channelAuthTenant

string

自选。 oauth 令牌租户。

oAuthScope

string

令牌的范围。

属性详细信息

appId

appId: string

属性值

string

oAuthEndpoint

获取要使用的 OAuth 终结点。 设置要使用的 OAuth 终结点。

string oAuthEndpoint

属性值

string

要使用的 OAuthEndpoint。

oAuthScope

获取要使用的 OAuth 范围。 设置要使用的 OAuth 范围。

string oAuthScope

属性值

string

要使用的 OAuth 范围。

tokenCacheKey

tokenCacheKey: string

属性值

string

方法详细信息

getToken(boolean)

获取 OAuth 访问令牌。

function getToken(forceRefresh?: boolean): Promise<string>

参数

forceRefresh

boolean

若要强制刷新令牌，则为 True;如果存在缓存令牌，则为 false。

返回

Promise<string>

表示要执行的工作的 Promise。

注解

如果承诺成功，则结果包含访问令牌字符串。

isTrustedServiceUrl(string)

警告

现已弃用此 API。

检查服务 URL 是否为受信任的主机。

static function isTrustedServiceUrl(serviceUrl: string): boolean

参数

serviceUrl

string

服务 URL

返回

boolean

如果服务 URL 的主机受信任，则为 True;否则为 False。

signRequest(WebResource)

将凭据应用于 HTTP 请求。

function signRequest(webResource: WebResource): Promise<WebResource>

参数

webResource

WebResource

WebResource HTTP 请求。

返回

Promise<WebResource>

表示异步操作的 Promise。

trustServiceUrl(string, Date)

警告

现已弃用此 API。

将服务 URL 的主机添加到受信任的主机。 如果未提供过期时间，则到期日期将为当前 （utc） 日期 + 1 天。

static function trustServiceUrl(serviceUrl: string, expiration?: Date)

参数

serviceUrl

string

服务 URL

expiration

Date