Microsoft 365 全体での TeamsJS 機能のサポート

バージョン 2.0.0 以降では、Microsoft Teams JavaScript クライアント ライブラリ (TeamsJS) を使用すると、 特定の種類の Teams アプリ を Microsoft 365 エコシステム全体で実行できます。 Teams アプリ (Microsoft 365 アプリと Outlook) をホストできる Microsoft 365 アプリケーションでは、Teams プラットフォーム用に構築できるアプリケーションの種類と機能のサブセットのみがサポートされます。 このサポートは時間の経過と同時に拡張されます。

この記事では、さまざまなホスト アプリケーションにわたる TeamsJS バージョン 2.x 機能のサポートレベルについて詳しく説明します。 TeamsJS バージョン 1.x と 2.x の間で変更された内容の詳細については、「 TeamsJS バージョン 2.x.x の新機能」を参照してください。

次の TeamsJS 機能 の表に、TeamsJS の機能 (パブリック名前空間) と、Microsoft 365 ホスト アプリケーション全体でのサポートの一覧を示します。 一部の機能は 、非推奨 または プレビュー バッジでマークされています。次の意味があります。

バッジ	意味
	この機能はプレビュー段階であり、フィードバックに基づいて変更される可能性があります。 運用環境ではこの機能を使用しないでください。
	この機能は、下位互換性のためにサポートされていますが、新しい機能を優先して非推奨になっています。 新しいアプリの場合は、非推奨の機能の使用ノートで推奨される機能を使用してください。

Microsoft 365 ホストは、次の表の製品アイコンによって示されます。

Teams	Microsoft 365 アプリ	Outlook

新しい Teams と Outlook の詳細については、「 Outlook ブログ と Teams の 導入」を参照してください。

次の表を使用して、参照ドキュメント、サンプル、使用状況に関するメモ、制限事項など、さらに詳しい情報を得るための TeamsJS 機能を選択します。

注:

次の表の情報は、TeamsJS v2.24 で行われたテストと、テスト中に利用可能な最新のホスト バージョンから派生しています。 サポートは、後続のホストの変更によって異なる場合があります。 これらのテーブルは、ホスト間での機能のサポートを理解するのに役立ちますが、コード内の関連する isSupported() 呼び出しを必ず使用してサポートを確認してください。

クロスホスト機能

次の表に、Teams の外部で実行できる TeamsJS 機能に対するホスト アプリケーションのサポートを示します。

TeamsJS 機能	Web				Desktop					Mobile
					Windows					Android			iOS
アプリ	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
appInstallDialog	✓	✓	✓		✓	✓	✓			✓			✓
authentication	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
calendar				✓				✓	✓			✓			✓
通話	✓	✓		✓	✓	✓			✓	✓			✓
	✓	✓		✓	✓	✓			✓	✓			✓
		✓	✓	✓		✓	✓	✓	✓		✓			✓	✓
dialog	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓			✓
geoLocation バッジ		✓	✓			✓	✓	✓
mail				✓				✓	✓						✓
pages	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
		✓		✓		✓		✓	✓
	✓	✓		✓	✓	✓		✓	✓
secondaryBrowser バッジ											✓	✓		✓	✓

Teams のみの機能

次の表に、Teams 環境でのみ実行される TeamsJS 機能のサポートを示します。

TeamsJS 機能	Web				Desktop					Mobile
					Windows					Android			iOS
appInitialization バッジ	✓				✓					✓			✓
location	✓	✓			✓	✓				✓			✓
メニュー					✓					✓			✓
people	✓	✓			✓	✓				✓			✓
settings	✓				✓					✓			✓
共有	✓	✓			✓	✓				✓			✓
stageView バッジ	✓	✓			✓	✓
tasks	✓				✓					✓			✓
teamsCore	✓	✓			✓	✓				✓			✓
										✓			✓
webStorage バッジ					✓					✓			✓

ホストのサポートを待機しているプレビュー機能

ソースの一部の機能は早期プレビュー段階にあり、 barCode、 メディア、 会議を含む 1 つ以上のホスト アプリケーションでの初期サポートをまだ待っています。

この記事の後半では、Teams JavaScript クライアント ライブラリの各機能の詳細を確認できます。

app

リファレンス | 既知の問題

アプリの初期化とライフサイクルと対話する名前空間。

app名前空間は、すべてのアプリケーション ホストでグローバルにサポートされているため、isSupported関数はありません。

	Web				Desktop					Mobile
					Windows					Android			iOS
アプリ	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓

appInitialization

リファレンス | 既知の問題

非推奨。 アプリを初期化するための名前空間。 新しいアプリの場合は、アプリ機能のapp.initialize() を使用します。

	Web				Desktop					Mobile
					Windows					Android			iOS
appInitialization バッジ	✓				✓					✓			✓

appInstallDialog

リファレンス | 既知の問題

アプリケーションをインストールするためのダイアログを開くために使用される名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
appInstallDialog	✓	✓	✓		✓	✓	✓			✓			✓

authentication

リファレンス | 既知の問題

ライブラリの認証関連部分と対話する名前空間。 このモジュールは、認証フローの開始または完了に使用されます。

authentication名前空間は、すべてのアプリケーション ホストでグローバルにサポートされているため、isSupported関数はありません。

	Web				Desktop					Mobile
					Windows					Android			iOS
認証	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓

barCode

リファレンス | 既知の問題

プレビュー。 ライブラリのバーコード スキャン関連の部分と対話する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
barCode バッジ

calendar

リファレンス | 既知の問題

カレンダー関連の機能を提供する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
calendar				✓				✓	✓			✓			✓

call

リファレンス | 既知の問題

他のユーザーとの呼び出しを開始するための機能を提供する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
通話	✓	✓		✓	✓	✓			✓	✓			✓

chat

リファレンス | 既知の問題

プレビュー。 他のユーザーとチャットを開始するための機能を提供する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
	✓	✓		✓	✓	✓			✓	✓			✓

clipboard

Reference

プレビュー。 この機能を使用すると、ユーザーはシステム クリップボードにコピーして貼り付けることができます。

	Web				Desktop					Mobile
					Windows					Android			iOS
		✓	✓	✓		✓	✓	✓	✓		✓			✓	✓

dialog

リファレンス | 既知の問題

プレビュー。 この機能グループを使用すると、アプリでモーダル ダイアログ (TeamsJS v1.x のタスク モジュールと呼ばれます) を表示できます。 ダイアログには、URL ベースのダイアログとアダプティブ カード ダイアログの 2 種類があります。 どちらの種類のダイアログもアプリの上に表示され、表示中にアプリとの対話が妨げられます。

• URL ベースのダイアログでは、ダイアログ内にコンテンツを表示する URL を指定できます。 URL ダイアログの場合は、url 名前空間の関数とインターフェイスを使用します。
• アダプティブ カードベースのダイアログでは、ダイアログ内に表示されるアダプティブ カードを記述する JSON を提供できます。 アダプティブ カード ダイアログの場合は、adaptiveCard 名前空間の関数とインターフェイスを使用します。

	Web				Desktop					Mobile
					Windows					Android			iOS
dialog	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓			✓
dialog.adaptiveCard バッジ		✓	✓			✓	✓	✓		✓			✓
dialog.adaptiveCard.bot バッジ		✓				✓		✓		✓			✓
dialog.update	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓			✓
dialog.url バッジ	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓			✓
dialog.url.bot バッジ	✓	✓		✓	✓	✓		✓	✓	✓			✓

dialog.adaptiveCard

リファレンス | 既知の問題

プレビュー。 アダプティブ カード ダイアログと対話するためのサブキャビリティ。

dialog.adaptiveCard.bot

リファレンス | 既知の問題

プレビュー。 Bot Framework と通信する必要があるアダプティブ カード ダイアログとの対話のサブキャビリティ。

dialog.update

リファレンス | 既知の問題

プレビュー。 ダイアログを更新するための名前空間。

dialog.url

リファレンス | 既知の問題

プレビュー。 HTML ベースのダイアログと対話するためのサブキャビリティ。

dialog.url.bot

リファレンス | 既知の問題

プレビュー。 Bot Framework と通信する必要がある HTML ベースのダイアログと対話するためのサブキャビリティ。

geoLocation

リファレンス | 既知の問題

プレビュー。 場所に関連する機能を提供する名前空間。 これは、場所モジュールの新しいバージョンです。

ユーザーがデバイスのアクセス許可 (geoLocation など) を付与する必要がある機能は、Teams の外部で実行されているアプリで部分的にサポートされています。 ユーザーは、Outlook と Microsoft 365 アプリで実行する場合はアプリ ヘッダーから、またはモバイルのアプリ設定からアプリのアクセス許可を調整できます。 コードを変更して、Outlook と Microsoft 365 のサポート可能性を確認することをお勧めします。

• 使用する前に、機能の isSupported を呼び出します。
• TeamsJS API と HTML5 API を呼び出すときのエラーをキャッチして処理する

API でエラーがサポートまたは生成されない場合は、失敗するロジックを追加するか、回避策を提供します。 例:

• ユーザーをアプリの Web サイトに誘導する
• Teams でアプリを使用してフローを完了するようにユーザーに指示する
• 機能がまだ利用できないことをユーザーに通知する

ヒント

アプリ マニフェストで、使用しているデバイスのアクセス許可のみが指定されていることを確認します。

	Web				Desktop					Mobile
					Windows					Android			iOS
geoLocation バッジ		✓	✓			✓	✓	✓
geoLocation.map バッジ		✓				✓

geoLocation.map

リファレンス | 既知の問題

プレビュー。 マップ関連の機能を提供するサブキャビリティ。

location

リファレンス | 既知の問題

非推奨。 場所に関連する機能を提供する名前空間 (場所の取得と表示)。 新しいアプリには geoLocation を使用します。

	Web				Desktop					Mobile
					Windows					Android			iOS
location	✓	✓			✓	✓				✓			✓

mail

リファレンス | 既知の問題

電子メール関連の機能を提供する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
mail				✓				✓	✓						✓

media

リファレンス | 既知の問題

イメージ ファイル関連の機能を提供する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
メディア

meeting

リファレンス | 既知の問題

会議中のアプリ機能を提供する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
会議

注:

Teams モバイル クライアントでは、次のメソッドはサポートされていません。

• meeting.requestStartLiveStreaming
• meeting.requestStopLiveStreaming
• meeting.getLiveStreamState
• meeting.registerLiveStreamChangedHandler

menus

リファレンス | 既知の問題

ライブラリのメニュー関連の部分と対話する名前空間。 このモジュールは、 ビュー構成、 アクション メニュー、 ナビゲーション バー メニューを表示するために使用されます。

	Web				Desktop					Mobile
					Windows					Android			iOS
メニュー					✓					✓			✓

pages

リファレンス | 既知の問題

TeamsJS ライブラリのナビゲーション関連の部分。

TeamsJS バージョン 2.0 より前のバージョンでは、すべてのディープ リンク シナリオは、(アプリの特定の部分へのリンクを生成するために) shareDeepLinkとexecuteDeepLink (アプリからまたはアプリ内のディープ リンクに移動する) を使用して処理されていました。 TeamsJS v.2.0 では、アプリ ホスト (Microsoft 365 アプリと Outlook、 Teams に加えて) 間で一貫した方法でアプリ内のページ (およびサブページ) に移動するための新しい API ( navigateToApp) が導入されています。 新しいアプリの場合は、ナビゲーション シナリオに応じて、リンクされた更新されたガイダンスに従ってください。

• アプリへのディープ リンク。 ユーザーが共有するためのコピー可能なリンクを生成して表示するには、pages.shareDeepLink (TeamsJS v.2.0 より前は shareDeepLink と呼ばれていました) を使用します。 選択すると、アプリケーション ホスト用にまだインストールされていない場合は、アプリのインストールを求めるメッセージが表示されます。

• アプリ内のナビゲーション。 新しい pages.currentApp 名前空間を使用して、ホスティング アプリケーション内のアプリ内を移動します。 具体的には、関数 navigateTo(NavigateWithinAppParams) 、現在のアプリ内の特定のタブへのナビゲーションを許可し、関数 navigateToDefaultPage() アプリのマニフェストで定義されている最初のタブに移動できるようにします。 詳細については、「 タブ アプリ内を移動する」を参照してください。

  これらの API は、アプリで URL を構築したり、アプリケーション ホストごとに異なるディープ リンク形式を管理したりする必要なく、ディープ リンクへの移動と同等の機能を提供します (現在非推奨の executeDeepLink が使用されていたので)。

• アプリのディープ リンク。 アプリから現在のホストのさまざまな領域へのディープ リンクについては、TeamsJS ライブラリによって提供される型指定された API を使用します。 たとえば、 calendar 機能を使用して、アプリからスケジュール 設定ダイアログまたは予定表アイテムを開きます。

  アプリから同じホストで実行中の他のアプリへのディープ リンクを生成するには、pages.navigateToApp を使用します。

  その他の外部へのディープ リンク シナリオでは、app.openLink を使用できます。これは、現在 (TeamsJS v.2.0 以降で) 非推奨になった executeDeepLink API と同様の機能を提供します。

	Web				Desktop					Mobile
					Windows					Android			iOS
pages	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
pages.appButton	✓	✓	✓		✓	✓	✓
pages.backStack	✓	✓			✓	✓				✓	✓	✓	✓		✓
pages.currentApp		✓	✓	✓		✓	✓	✓	✓		✓	✓		✓	✓
pages.config	✓	✓			✓	✓		✓		✓		✓	✓		✓
pages.tabs	✓	✓			✓	✓

注:

Teams モバイル クライアントでは、次のメソッドはサポートされていません。

• pages.getConfig
• pages.setCurrentFrame
• pages.initializeWithFrameContext
• pages.tabs.navigateToTab
• pages.tabs.getMruTabInstances
• pages.tabs.getTabInstances

pages.appButton

リファレンス | 既知の問題

SDK のアプリ ボタン部分と対話するための API を提供します。

pages.backStack

リファレンス | 既知の問題

ユーザーのナビゲーション履歴を処理するための API を提供します。

pages.config

リファレンス | 既知の問題

SDK の構成固有の部分と対話するための API を提供します。 このオブジェクトは、構成フレームでのみ使用できます。

pages.currentApp

リファレンス | 既知の問題

アプリケーション ID を指定せずに移動するための関数を提供します。

pages.tabs

リファレンス | 既知の問題

アプリケーションのコンテキスト タブ間でクエリを実行および移動するための API を提供します。 個人用タブとは異なり、コンテキスト タブはチャネルやチャットなどの特定のコンテキストに関連付けられたページです。

people

リファレンス | 既知の問題

People Picker API の機能を提供する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
people	✓	✓			✓	✓				✓			✓

profile

リファレンス | 既知の問題

プレビュー。 プロファイル関連の機能を提供する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
		✓		✓		✓		✓	✓

注:

profile.showProfile メソッドは、Teams モバイル クライアントではサポートされていません。

search

リファレンス | 既知の問題

プレビュー。 アプリケーションがホスト Microsoft 365 アプリケーションの検索ボックスと対話できるようにします。 アプリケーションをホストの検索ボックスと統合することで、ユーザーは Teams、Outlook、または Microsoft 365 アプリの他の場所で使用するのと同じ検索ボックスを使用してアプリを検索できます。

	Web				Desktop					Mobile
					Windows					Android			iOS
	✓	✓		✓	✓	✓		✓	✓

secondaryBrowser

リファレンス | 既知の問題

プレビュー。 ホスト アプリのアプリ内ブラウザー エクスペリエンスをサポートする名前空間。 たとえば、ブラウザー内のホスト アプリで URL を開くとします。

	Web				Desktop					Mobile
					Windows					Android			iOS
secondaryBrowser バッジ											✓	✓		✓	✓

settings

リファレンス | 既知の問題

非推奨。 設定に関連する機能を提供します。 新しいアプリの ページ から同等の API を使用します。

	Web				Desktop					Mobile
					Windows					Android			iOS
settings	✓				✓					✓			✓

sharing

リファレンス | 既知の問題

Web コンテンツの共有ダイアログを開く名前空間。 詳細については、「個人用アプリまたはタブから Teams に共有する」を参照してください。

	Web				Desktop					Mobile
					Windows					Android			iOS
共有	✓	✓			✓	✓				✓			✓

注:

sharing.shareWebContent メソッドは、Teams モバイル クライアントではサポートされていません。

stageView

リファレンス | 既知の問題

プレビュー。 ライブラリの Stageview 特定の部分と対話する名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
stageView バッジ	✓	✓			✓	✓

tasks

リファレンス | 既知の問題

モーダル ダイアログを提供するための以前のバージョンの機能 (TeamsJS v1.x ではタスク モジュールと呼ばれます) では、TeamsJS v2.8.0 より前のバージョンがサポートされています。 新しいアプリの場合は、 ダイアログ 機能を使用します。

	Web				Desktop					Mobile
					Windows					Android			iOS
tasks	✓				✓					✓			✓

注:

task.getDefaultSizeIfNotProvided メソッドは、Teams モバイル クライアントではサポートされていません。

teamsCore

リファレンス | 既知の問題

Teams 固有の機能をサポートする API のセットを含む名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
teamsCore	✓	✓			✓	✓				✓			✓

video

リファレンス | 既知の問題

プレビュー。 会議中のビデオ効果の機能を表す名前空間。

	Web				Desktop					Mobile
					Windows					Android			iOS
										✓			✓

注:

Teams モバイル クライアントでは、次のメソッドはサポートされていません。

• video.notifySelectedVideoEffectChanged
• video.registerForVideoEffect

webStorage

リファレンス | 既知の問題

プレビュー。 Web アプリが Webview キャッシュにデータを格納できるようにする機能が含まれています。

	Web				Desktop					Mobile
					Windows					Android			iOS
webStorage バッジ					✓					✓			✓

注:

webStorage.isWebStorageClearedOnUserLogOut メソッドは、Teams モバイル クライアントではサポートされていません。

関連項目

• Teams アプリを Microsoft 365 全体に拡張する
• Microsoft 365 アプリ全体で Teams 個人用タブを拡張する
• TeamsJS API リファレンス