Alier.Native.createNotification()

引数で与えられた、通知の契機、通知情報で通知の作成（登録）を行います。
この関数は非同期関数です。

構文

Alier.Native.createNotification(payload,trigger) => Promise<object>

引数

• payload: object
  通知情報をまとめたオブジェクトです。

• trigger: object
  通知契機の内容をまとめたオブジェクトです。

返値: Promise<object>

契機毎に登録した通知の管理識別子をPromise<object>として返します。

//タイマ契機だけを登録した場合の結果
{
    timer: "通知ID"
}

//カレンダ契機だけを登録した場合の結果
{
    calendar: "通知ID"
}
//タイマ契機とカレンダ契機の両方を登録した場合の結果
{
    timer: "通知ID",
    calendar: "通知ID"
}

例

//通知情報
const payload = {
            title:`タイトル`,
            message:"メッセージ",
            manageId:"test",
            data:{
                "sample":"通知に渡すパラメータ"
            },
            badge:1,
            image:"app_res/images/sample_image.png",
            icon: "sample_icon"
        }

//通知契機
const trigger = {
       timer:{
            seconds:10,
            repeat:false,
       },
        calendar:{
            year:2025,
            month:4,
            day:23,
            hour:16,
            minute:21,
            second:15
        }
    }

const reslut = await Alier.Native.createNotification(payload,trigger);
console.log(reslut);//{timer: "test__alier__xxxx1", calendar: "test__alier__xxxx2"}

解説

ペイロードおよび契機の設定項目について

ペイロードの指定方法

通知で送る本文やタイトル・設定などの通知情報を、object形式でまとめたデータのことです。以下の項目を設定できます。

表1. ペイロード設定項目

補足

• manageId：　ネイティブ側で通知の作成を行う際に、この値を用いて「通知の識別子」を生成します。この値がそのまま通知の識別子となるわけではありません。

• sound: 通知音を設定します。未指定の場合はOSごとのデフォルトの通知音が鳴ります。今後対応予定の機能です。

• image: ローカルストレージ内にある画像リソースのパスを指定できます。

• badge： アイコンに表示する数字を指定できます。

• icon：　通知バナー用のアイコンに使用するリソースのパスを指定できます。Android側のみ指定可能です。

• data：　通知バナータップ時にイベントハンドラを通じて取得することができます。

契機の指定方法

• 契機の指定情報をobject形式でまとめたデータのことです。以下の項目を設定できます。

  note

  契機設定は、モバイル側のローカルPush通知のみ対応しています。

タイマ契機について

表1. タイマの契機名

表2. timerオブジェクト配下に追加できる項目

カレンダ契機について

表1. カレンダの契機名

表2. カレンダオブジェクト配下に定義できる項目

表3. repeatTypeの指定項目名について

カレンダトリガー補足

• 通知の優先評価順位

  時刻 > repeatで使用する値 > 年月日 > 曜日 > その他(weekOfMonth ,adjustEndOfMonth)

• 表1. ケース別の定義例

  ケース	使用するカレンダオブジェクトの項目など
  特定の日時に1回だけ通知	year, month, day, hour, minute,second
  毎年同じ日（例: 毎年1月1日）	month, day, hour, minute,second　 repeatType=year
  毎月同じ日（例: 毎月10日）	day, hour, minute,second repeatType=month
  毎週同じ曜日（例: 毎週月曜10時）	weekday, hour, minute,second repeatType=week
  毎日同じ時間（例: 毎日8:30）	hour, minute,second repeatType=day

(例)　

• 「2025/03/21 11:30:00 の金曜日」に１回だけ通知を出したい場合

    calendar:{
        {
            year: 2025,
            month: 3,
            day: 21,
            hour: 11,
            minute: 30
            seconds: 0
        }
    }

• 金曜日に１回だけ通知を出したい場合。

    //「時刻」として「11:30:00」、 「weekday」に金曜日を指定する。
    calendar:{
        {
            hour: 11,
            minute: 30
            seconds: 0,
            weekday: 6
        }
    }

• 「2025/03/21 11:30:00から毎週金曜日」に繰り返したい場合。
  • 「2025/03/21 から毎週金曜に通知」するための直接的な方法がないため以下の方法で、通知を登録することになります。
    • 方法１
      • （1）特定の日時に１回だけ行う通知を登録する。
        (例)「2025/03/21 11:30:00 の金曜日に１回出す通知」を登録する。
      • （2）(1)の通知がきたタイミングで、指定の繰り返しを行う通知を登録する。 (例)「毎週金曜日に出す通知」を登録する。
    • 方法２
      • 「2025/03/20の11:31」以降に以下のような形で契機を登録する。

        calendar:{
          {
              hour: 11,
              minute: 30,
              seconds: 0,
              weekday: 6,
              repeatType: "week"
          }
        }

        ---