什么是 Teams JavaScript 客户端库?
Teams 开发平台为客户端应用程序提供 Teams JavaScript 客户端库作为 JavaScript 库。 该库是 JavaScript 函数的集合,可通过这些函数使用 Teams API 将特性和功能集成到 Teams 应用程序中。 特性和功能显示为 Teams 客户端的本机功能。 该库可确保使用它生成的应用程序为 Teams 用户提供一致且用户友好的体验。
在本单元中,你将了解如何在应用程序中使用该库。
将库引入应用
让我们看看在应用程序中安装库的不同方法。
可以使用 npm 或 yarn 安装 Teams JavaScript 客户端库的 LTS 版本。
若要使用 npm 安装库,请执行以下操作:
npm install --save @microsoft/teams-js
若要使用 yarn 安装库,请执行以下操作:
yarn add @microsoft/teams-js
如果在不使用捆绑程序的情况下生成 Web 应用,可以直接从内容分发网络加载库。 将以下代码片段添加到 Web 应用:
<script src="https://res.cdn.office.net/teams-js/2.7.1/js/MicrosoftTeams.min.js "></script>
如何使用库
Teams JavaScript 客户端库具有按逻辑分组为功能的 API。 这些功能是库中的命名空间。 顶级命名空间应用包含整体应用使用情况所需的所有 API。
可以使用 初始化库 app.Initialize()
。 初始化库后,可以开始使用 命名空间来访问库中包含的所有 API 和功能。 若要获取应用的基本上下文信息,请调用 app.getContext()
。 若要生成并显示可复制的链接,该链接指向要共享的信息,请调用 pages.shareDeepLink()
。
若要获取应用的上下文信息,请运行以下代码:
await app.initialize();
const context = await app.getContext();
获取有关 Microsoft Teams 的上下文信息可帮助 Teams 应用为用户提供更好、更量身定制的体验。 例如,通过上下文信息,你的应用可以了解运行它的特定环境,例如在 Teams 中、浏览器、团队或频道中,甚至是与应用交互的用户。 这些见解可用于确定如何正确配置和向用户显示相关和自定义的功能。
功能
SDK 中的 API 按逻辑分组,称为功能。 功能的示例包括聊天、对话和身份验证。 每个功能都有自己的命名空间;例如聊天、对话或页面。
注意
Teams JavaScript 客户端库 2.0.0 及更高版本使 Teams 应用能够在 Outlook 和 Office.com 等其他主机应用中运行。 这些扩展性功能目前在这些应用上处于预览状态。
将 Microsoft Teams 视为应用的当前主机。 主机具有一些可以集成到应用中的功能。 例如,你的应用可以通过调用 chat.openChat()
Microsoft Teams 聊天功能的 函数来启动新的聊天。 这会与用户打开新的 1:1 聊天。
可以对每个功能使用 <the-capability>.isSupported()
函数来检查主机是否支持该功能。 例如,在调用 chat.openChat()
之前,你可能想要检查运行应用的主机应用中是否支持聊天。 若要检查,请调用函数 chat.isSupported()
。 如果聊天受支持,如果false
聊天不受支持,则返回 true
。 此检查允许应用仅运行主机应用中支持的功能,因此用户在每个主机中都有更自然的体验。