Jetpack ではユーザがあなたのjetpackをインストールする際に表示される任意の内容を指定することが出来ます。インストール完了後に呼び出されるコールバックを登録することも可能です。
初回起動ページ
ユーザがあなたのjetpackをインストールすると、インストールが成功したことを知らせる新しいページに誘導されます。標準では、このページにはユーザが既にjetpackを利用できるようになった事と、アンインストールの方法を説明する簡単な文章が含まれます。あなたはこの文章をあなたのjetpackに適した内容のページで置き換える事が出来ます。例えば、ユーザにあなたのjetpackの使い方を説明したり、あなたのjetpackのホームページへのリンクを掲載することができます。このページはHTMLあるいは外部URLとして定義することが出来ます。
初回起動ページはあなたの jetpackマニュフェストの firstRunPage
プロパティで定義されます。マニュフェストは manifest という変数名が設定された単なるオブジェクトです。この変数はjetpack内のグローバル名前空間であればどこでも定義することが出来ます。マニュフェストはjetpackに settings を定義する際に使用するのと同じものです。
firstRunPage
の値は string もしくは E4X XML のいずれかで無ければいけません。もし、値が string かつ有効なURLであれば、そのURLが示すページが初回起動ページとなります。それ以外の場合、値はHTMLと見なされ、初回起動ページの body
となります。
この例は初回起動ページをHTMLで設定しています:
var manifest = { firstRunPage: '<p>Thanks for installing! Visit my <a href="https://example.com/myJetpack">homepage</a>.</p>' };
これは上の例と同じ内容ですが、E4X XML を使用しています:
var manifest = { firstRunPage: <> <p> Thanks for installing! Visit my <a href="https://example.com/myJetpack">homepage</a>. </p> </> };
この例では https://example.com/myJetpack
にあるページが初回起動ページとなります:
var manifest = { firstRunPage: "https://example.com/myJetpack" };
初回起動コールバック
あなたのjetpackが正常にインストールされた後に呼び出されるコールバックを登録することが可能です。jetpack.me.onFirstRun()
を参照。