Utility class

包:

@microsoft/agents-a365-runtime

实用工具类为代理运行时作提供帮助程序方法。

方法

getAgentIdFromToken(string)	警告：无签名验证 - 此方法使用 jwt.decode（），但不验证令牌签名。 恶意参与者可以欺骗令牌声明。 此方法仅适用于日志记录、分析和诊断目的。 请勿将返回的值用于授权、访问控制或安全决策。 解码令牌并检索最佳可用代理标识符。 按优先级顺序检查声明：xms_par_app_azp（代理蓝图 ID） > appid > azp。 注意：返回空/缺失令牌的空字符串（与返回默认 GUID 的 GetAppIdFromToken 不同）。 这样，当没有可用的标识符时，调用方就可以省略标头。
GetAppIdFromToken(string)	警告：无签名验证 - 此方法使用 jwt.decode（），但不验证令牌签名。 恶意参与者可以欺骗令牌声明。 此方法仅适用于日志记录、分析和诊断目的。 请勿将返回的值用于授权、访问控制或安全决策。 解码当前令牌并检索应用 ID（appid 或 azp 声明）。 注意：返回一个默认 GUID （'00000000-0000-0000-0000-000000000000000'）作为空令牌，以便与需要有效 GUID 的调用方向后兼容。 对于首选空字符串的代理标识，请使用 getAgentIdFromToken。
getApplicationName()	从npm_package_name环境变量或 package.json获取应用程序名称。 package.json 结果在模块加载时缓存，以避免在请求期间同步 I/O。
GetUserAgentHeader(string)	生成包含 SDK 版本、OS 类型、Node.js 版本和业务流程协调程序的 User-Agent 标头字符串。
ResolveAgentIdentity(TurnContext, string)	从轮次上下文或身份验证令牌解析代理标识。

方法详细信息

getAgentIdFromToken(string)

警告：无签名验证 - 此方法使用 jwt.decode（），但不验证令牌签名。 恶意参与者可以欺骗令牌声明。 此方法仅适用于日志记录、分析和诊断目的。 请勿将返回的值用于授权、访问控制或安全决策。

解码令牌并检索最佳可用代理标识符。 按优先级顺序检查声明：xms_par_app_azp（代理蓝图 ID） > appid > azp。

注意：返回空/缺失令牌的空字符串（与返回默认 GUID 的 GetAppIdFromToken 不同）。 这样，当没有可用的标识符时，调用方就可以省略标头。

static function getAgentIdFromToken(token: string): string

参数

token

string

要解码的 JWT 令牌

返回

string

找不到代理 ID（GUID）或空字符串或令牌为空

GetAppIdFromToken(string)

警告：无签名验证 - 此方法使用 jwt.decode（），但不验证令牌签名。 恶意参与者可以欺骗令牌声明。 此方法仅适用于日志记录、分析和诊断目的。 请勿将返回的值用于授权、访问控制或安全决策。

解码当前令牌并检索应用 ID（appid 或 azp 声明）。

注意：返回一个默认 GUID （'00000000-0000-0000-0000-000000000000000'）作为空令牌，以便与需要有效 GUID 的调用方向后兼容。 对于首选空字符串的代理标识，请使用 getAgentIdFromToken。

static function GetAppIdFromToken(token: string): string

参数

token

string

要解码的令牌

返回

string

AppId 或空令牌的默认 GUID;如果解码失败，则为空字符串

getApplicationName()

从npm_package_name环境变量或 package.json获取应用程序名称。 package.json 结果在模块加载时缓存，以避免在请求期间同步 I/O。

static function getApplicationName(): undefined | string

返回

undefined | string

应用程序名称或未定义（如果不可用）。

GetUserAgentHeader(string)

生成包含 SDK 版本、OS 类型、Node.js 版本和业务流程协调程序的 User-Agent 标头字符串。

static function GetUserAgentHeader(orchestrator?: string): string

参数

orchestrator

string

要包含在 User-Agent 字符串中的可选业务流程协调程序标识符。

返回

string

格式化 User-Agent 标头字符串。

ResolveAgentIdentity(TurnContext, string)

从轮次上下文或身份验证令牌解析代理标识。

static function ResolveAgentIdentity(context: TurnContext, authToken: string): string

参数

context

TurnContext

轮次的轮次上下文。

authToken

string

身份验证令牌（如果可用）。

返回

string

代理标识 （应用 ID）