Phonegap Push プラグイン

この Cordova プラグインでは、プッシュ通知の登録と受信を行います。

• Repo: https://github.com/phonegap/phonegap-plugin-push

• Plugin ID/Package Name: phonegap-plugin-push

• Tested Version: 2.3.0

デモ

プロジェクトをインポート

IOSの準備

iOS 向けのプッシュ通知を使用する場合は、APNs の認証キーまたは APNs 証明書が必要になります。 ここでは、iOS デバッグビルド用の Development APNs 署名書の作成方法を説明します。

既に Apple Developer Program をお持ちの場合は、以下の手順に従って Development APNs 証明書を作成してください。

1. Apple Developer page から、Account に移動します。

2. Certificates, Identifiers & Profiles を選択します。

3. APNs 証明書を作成する場合は、プッシュ通知を有効にした App ID が必要になります。Identifiers 項目の App IDs 選択し、右上隅の + ボタンをクリックします。

4. 次のような App ID 情報を入力します。

• App Description: アプリ名を入力します ( 例：Cordova Firebase Demo )

• Explicit ID: プッシュ通知では、ワイルドカードの App ID を使用できないため、このオプションを選択します。 アプリの固有の識別子（ io.monaca.firebase など ）を入力します。

5. App Services 項目の Push Notifications オプションをチェックし、Continueをクリックします。

6. Confirm your App ID ページにリダイレクトされます。 Register をクリックします。

7. iOS App IDs ページで作成した App ID を選択し、Edit をクリックします。

8. Push Notifications 項目にある Development SSL Certificate の Create Certificate をクリックします。

9. Continue をクリックします。

10. Choose File をクリックし、CSR ファイルを選択します。 CSR ファイルは、Monaca クラウド IDE の 設定 → iOS ビルド設定 から取得することができます。 秘密鍵と CSR の生成 をクリックし、CRSファイルを作成後 エクスポート ボタンをクリックしてダウンロードします。

11. 次に、Continue をクリックします。 証明書の準備でき、ダウンロード可能になったら証明書をダウンロードします。

12. ダウンロードした証明書を iOS ビルド設定 の 証明書のアップロード ボタンをクリックしてアップロードします。

13. Monacaに登録された証明書 に表示された証明書の エクスポート アイコンをクリックして p12 ファイルをエクスポートします。次の項目の Firebase の設定に必要になります。

Firebase ( プッシュ通知 ) の設定

1. Firebase Console にアクセスします。

2. Firebase Console にログインします。

3. プロジェクトを追加 をクリックします。

4. プロジェクト情報を入力し、 プロジェクトを作成 をクリックします。 その後、プロジェクト概要ページにリダイレクトされます。

プロジェクトを作成後、各プラットフォーム用プッシュ通知の設定を行うことができます。

iOS の場合

1. プロジェクトの設定　を選択します。

2. [全般] 項目で アプリを追加 をクリックし、iOS を選択します。

3. iOS のバンドル ID を入力します。( 設定 → iOS アプリ設定 ) で確認することができます)。 次に、アプリの登録 をクリックします。

4. GoogleService-Info.plist ファイルをダウンロードし、プロジェクトのルートフォルダに配置します。 次に、 続行 をクリックします。

5. [Firebase SDK の追加] では、Monacaで開発するアプリは、ネイティブアプリではないため、 続行 をクリックします。 次に、終了 をクリックして設定を完了します。その後、Firebase の概要ページに iOS アプリが表示されます。

6. 作成したプロジェクトに APNs 証明書を追加します。 プロジェクトの設定 に移動し、 クラウド メッセージングを選択します。

7. iOS アプリの設定 項目で、APNs 認証キーまたは APNs 証明書をアップロードします。

以上で、iOS 用の設定は完了です。

Android の場合

1. プロジェクトの設定　を選択します。

2. [全般] 項目で アプリを追加 をクリックし、Android を選択します。

3. パッケージ名を入力します ( 設定 → Android アプリ設定で確認することができます) 。 次に、アプリの登録 をクリックします。

4. google-services.json ファイルをダウンロードし、プロジェクトのルートフォルダに配置します。 次に、 続行 をクリックします。

5. [Firebase SDK の追加] では、Monacaで開発するアプリは、ネイティブアプリではないため、 続行 をクリックします。 次に、終了 をクリックして設定を完了します。その後、Firebase の概要ページに iOS アプリが表示されます。

Monaca クラウド IDE でプラグインを有効にする

1. IDE メニューから 設定 → Cordova プラグインの管理 へ移動します。

2. Cordova プラグインのインポートボタンをクリックします。 次に、[ZIP ファイル] または [パッケージ名 / URL] を使用してプラグインをインポートします。

使い方

プラグインをプロジェクトにインポート後、プッシュ通知の初期化を行います。 deviceready イベント後、プラグイン API 使用します。 例：

document.addEventListener("deviceready", onDeviceReady, false);        
function onDeviceReady() {

    // Notification initialization
    push = PushNotification.init({
        ios: {
            badge: true
        }
    });
    
    // Checking notification permission
    $interval(checkNotifPermiss, 500);
    // Updating App Icon Badge Number
    $interval(updateAIBN, 500);  

    // When receiving a push notification
    push.on('notification', data => {
        receiveNotifCB(data);
    });
}

API リファレンス

このページでは、デモ で使用されている主な API についてのみ説明します。API リファレンスについては、こちら を参照してください。

init()

プッシュ通知の初期化を行います。

PushNotification.init(options)

パラメーター

• iOS の場合

*: init メソッドが初めて実行されるときに設定されるオプションの値によって、アプリがどのように動作するかが決まります。 init メソッドで値が設定された場合でも、 設定 → 通知 → アプリ名 からユーザが手動で設定を変更することができます。これは通常のiOSの動作になります。

• Android の場合

戻り値

• pushObject

例

const push = PushNotification.init({
  android: {},
  browser: {
    pushServiceURL: 'http://push.api.phonegap.com/v1/push'
  },
  ios: {
    alert: 'true',
    badge: true,
    sound: 'false'
  },
  windows: {}
});

hasPermission()

プッシュ通知許可が端末で許可されているか確認します。

PushNotification.hasPermission(successHandler)

パラメーター

Callback パラメーター

• successHandler

戻り値

• Promise

例

PushNotification.hasPermission(data => {
  if (data.isEnabled) {
    console.log('isEnabled');
  }
});

getApplicationIconBadgeNumber()

アプリが実行されていないときに表示されている現在のバッジの数を取得します。

push.getApplicationIconBadgeNumber(successHandler, errorHandler)

パラメーター

Callback パラメーター

• successHandler

戻り値

• Promise

例

push.getApplicationIconBadgeNumber(
    n => {
        $scope.aibn = n;
    },
    () => {
        console.log('Error getting the number');
    }
);

setApplicationIconBadgeNumber()

アプリが実行されていないときに表示されるバッジの数を設定します。

push.setApplicationIconBadgeNumber(successHandler, errorHandler, count) 

パラメーター

戻り値

• Promise

例

push.setApplicationIconBadgeNumber(
    () => {
        alert("Successfully setting the badge number!");
    },
    () => {
        alert("Fail to set the badge number. Something went wrong...");
    },
    badgeNum
);

push.on()

notification イベントは、プッシュ通知サービスから送信されたプッシュ通知を受信した際に実行されます。

push.on('notification', callback)

Callback パラメーター

戻り値

• Promise

例

push.on('notification', data => {
  console.log(data.message);
  console.log(data.title);
  console.log(data.count);
  console.log(data.sound);
  console.log(data.image);
  console.log(data.additionalData);
});