Teams JavaScript クライアント ライブラリとは

• 2 分

Teams 開発プラットフォームは、クライアント アプリケーション用の JavaScript ライブラリとして Teams JavaScript クライアント ライブラリを提供します。 ライブラリは、Teams API を使用して Teams アプリケーションに機能と機能を統合するための JavaScript 関数のコレクションです。 機能と機能は、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 は論理的にグループ化され、機能と呼ばれます。 機能の例としては、チャット、ダイアログ、認証などがあります。 各機能には独自の名前空間があります。たとえば、チャット、ダイアログ、ページなどです。

Microsoft Teams は、アプリの現在のホストと考えてください。 ホストには、アプリに統合できるいくつかの機能があります。 たとえば、アプリは Microsoft Teams チャット機能の関数を chat.openChat() 呼び出すことによって、新しいチャットを開始できます。 これにより、ユーザーとの新しい 1:1 チャットが開きます。

各機能に関数を使用 <the-capability>.isSupported() して、その機能がホストによってサポートされているかどうかを確認できます。 たとえば、 を chat.openChat()呼び出す前に、アプリが実行されているホスト アプリでチャットがサポートされているかどうかを確認できます。 確認するには、 関数 chat.isSupported()を呼び出します。 チャットがサポートされている場合と、falseチャットがサポートされていない場合はが返trueされます。 このチェックにより、アプリはホスト アプリでサポートされている機能のみを実行できるため、ユーザーは各ホストでより自然なエクスペリエンスを得ることができます。