什麼是 Teams JavaScript 用戶端連結庫?

已完成

Teams 開發平臺提供 Teams JavaScript 用戶端連結庫作為用戶端應用程式的 JavaScript 連結庫。 連結庫是 JavaScript 函式的集合,您可以使用 Teams API 將功能整合到 Teams 應用程式中。 這些功能和功能在 Teams 用戶端中會顯示為原生功能。 連結庫可確保您使用它建置的應用程式對於 Teams 使用者具有一致且方便使用的體驗。

在此單元中,您將瞭解如何在應用程式中使用連結庫。

將連結庫放入您的應用程式

讓我們看看您可以在應用程式中安裝連結庫的不同方式。

您可以使用 npm 或 yarn 來安裝 LTS 版的 Teams JavaScript 用戶端連結庫。

若要使用 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 視為您應用程式的目前主機。 主機具有一些可整合到您應用程式中的功能。 例如,您的應用程式可以藉由呼叫 Microsoft Teams 聊天功能的 函式來 chat.openChat() 起始新的聊天。 這會開啟與使用者的新 1:1 聊天。

您可以使用 <the-capability>.isSupported() 函式來檢查主機是否支援此功能。 例如,在呼叫 chat.openChat()之前,您可能會想要檢查應用程式執行所在的主應用程式是否支援聊天。 若要檢查,您可以呼叫 函式 chat.isSupported()。 如果支援聊天,以及false不支援聊天,則會傳回 true 。 這項檢查可讓您的應用程式只執行主應用程式中支援的功能,讓使用者在每個主應用程式中都有更自然的體驗。