App Installation and Management API

Open Web Apps の JavaScript API は、Web アプリをインストールしたり、ユーザがインストールしているクライアントサイドの Web アプリのリストを管理したりするためのプログラミングインタフェースです。このリストは「アプリケーションレポジトリ」と呼ばれます。

機能の実装状況

ここで説明する JavaScript API は、デスクトップ版 Firefox、Android 版 Firefox および Firefox OS で利用可能です。

API のメソッド

アプリに関するメソッドはすべて navigator.mozApps オブジェクトからアクセスできます。API では以下の 2 種類の機能が使用可能です。

インストール機能: アプリのインストールやインストール済みアプリの管理に関するもの。これらは、ストア、自主配布アプリ、アプリディレクトリ向けです。
管理機能: アプリの表示、起動、同期に関するもの。主にダッシュボートで使われます。

インストール API (`navigator.mozApps.*`)

アプリインストール API は window.navigator.mozApps オブジェクトのメソッドとして提供されています。

管理 API (`navigator.mozApps.mgmt.*`)

アプリ管理 API は特権を必要とします。これは信頼できるページや「ダッシュボード」に対してアクセス権を与えることを意図したものです。管理 API は、ダッシュボードがユーザに代わってアプリの管理や起動を行えるようにする関数を提供します。またこの API は、ダッシュボードがユーザのログイン状況を表示したり、端末間でアプリを同期できるアカウントへユーザがログインあるいは登録したりすることを可能にする、アプリの同期機能も提供します。

navigator.mozApps.mgmt.getAll()

オブジェクト

以下の種類の JavaScript オブジェクトがアプリ API によって使用されます。

アプリを表す App オブジェクト。
いくつかのメソッドが返す DOMRequest オブジェクト。
メソッドによって返されるエラーを表す DOMError オブジェクト。

新旧 API

もしあなたが古い API を使っていた場合、それらは 2012 年 3 月の時点で廃止されています。旧 API と新 API の比較は以下の通りです。

navigator.mozApps.install(): この関数には変更されたシグネチャが含まれます。
navigator.mozApps.amInstalled(): navigator.mozApps.getSelf() に置き換えられました。
navigator.mozApps.getInstalledBy(): navigator.mozApps.getInstalled() に置き換えられました。
navigator.mozApps.mgmt.list(): navigator.mozApps.mgmt.getAll() に置き換えられました。
navigator.mozApps.mgmt.watchUpdates(onupdate) navigator.mozApps.mgmt.clearWatch(watchId): これらはそれぞれ navigator.mozApps.oninstall と navigator.mozApps.onuninstall に置き換えられました。
navigator.mozApps.mgmt.uninstall(origin, [onsuccess], [onerror]): navigator.mozApps.mgmt.uninstall(app) に置き換えられました。app は getAll() か app オブジェクトを扱う他の関数によって返されるオブジェクトです。