Local Push Notification

概要

• この機能はモバイル専用の機能です。

• 「ローカル契機」によるPush通知の実装をサポートする機能群です。

  note

  ここでの「ローカル契機」は、端末内からの契機のことを指しています。

• Alierで提供している通知の種類は以下の通りです。

  • デフォルト通知: タイトル、テキスト、画像など添付できる基本となる通知です。

• 実装方式は以下の通りです。

  • 簡単な通知: Alierが提供する通知関数を使用して、最小限の実装で通知を実現できる実装方法です。

    note

    「簡単な通知」ではデフォルト通知が適用されます。

• 「ローカル契機」として指定できるのは、以下の通りです。

  • タイマ契機
  • カレンダ契機

• 通知バナータップ時のイベントはaddListenerを利用して受け取ることができます。

通知の種類について

デフォルト通知

• タイトル、テキスト、画像など添付できる基本となる通知です。

• 使用方法は、Alierが提供する通知用関数を用いて実装することになります。

• 通知に表示できる項目は以下の通りです。

  • 通知アイコン:

    • 任意で指定した画像を、通知バナーのアイコンとして表示できます。

      note

      アイコン指定はAndroidのみ対応していいます。 iOSは、アプリアイコンが表示されます。

  • 通知タイトル:

    • 任意で指定したテキストを、通知タイトルとして表示できます。

  • 通知メッセージ:

    • 任意で指定したテキストを、通知メッセージとして表示できます。

  • 通知バッジ:

    • 任意で指定した数字を、アプリアイコン上にとして表示できます。

      note

      Androidについては端末や設定状況によって、通知ドットとして表示される場合があります。

  • 画像： 　

    • 任意で指定した画像を、通知に表示できます。

• 表示以外に指定できる項目は以下の通りです。

  • 通知音:

    • 通知時のサウンドを指定できます。
    • 未指定の場合にはそれぞれのOSで設定されているデフォルトの通知音が鳴ります。

  • データ：

    • 通知バナータップ時などに取得できる内部データを通知に添付できます。

実装方式について

簡単な通知

• Alierが提供する通知関数を使用し最小限の実装で通知を実現できる実装方法です。
• Alier側であらかじめ登録してあるネイティブ側の関数を呼び出す形で、通知に関する操作を行います。対応している操作は以下の通りです。
  • createNotification():通知を作成する際に使用する関数です。
  • deleteNotification():登録されている通知を削除する際に使用する関数です。
  • setbadgenumber():通知バッジに表示する数字を指定する際に使用する関数です。

契機について

タイマ契機

• 指定秒数後に通知を行います。
• 単位：秒
• 即時通知を利用する場合にも対応しています。

カレンダ契機

• 指定日時に通知を行います。

通知バナータップ時のイベント取得について

• 通知バナータップ時のイベントはaddListenerを利用して受け取ることができます。

addListenerのイベント名

• notified

//ペイロードのデータが以下の形である場合
/*
    data: {
        "test_01": "Hello!";
    }
*/

Alier.SysEvent.addListener(message => {
    switch (message.id) {
        //通知バナータップ時のイベント取得
        case "notified": {
            const param = message.param;
            const notificationData = param.data
            console.log(notificationData.["test_01"])// Hello!
            break;
        }
        break;
    }
});

使い方

• 契機１種類につき１つの通知を作成できます。

• 詳しい実装例は、ローカルPush通知の実装例に記載しています。

メソッド

createNotification(payload,trigger)

• 通知を作成します。

deleteNotification(notificationId)

• 登録されている通知を削除します。

setbadgenumber(number)

• 通知バッジに表示する数字を指定できます。