@capacitor/local-notifications
ローカル通知APIは、デバイス通知をローカルに（つまり、サーバーからプッシュ通知を送信せずに）スケジュールする方法を提供します。
インストール
npm install @capacitor/local-notifications
npx cap sync
Android
Android 13では、通知を送信するためにパーミッションチェックが必要です。 checkPermissions()とrequestPermissions()を適切に呼び出す必要があります。
Android 12以前では、プロンプトは表示されず、許可済みとして返されます。
Android 12以降では、このパーミッションがAndroidManifest.xmlに追加されていない限り、スケジュールされた通知は正確には実行されません。
<uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" />
パーミッションが存在していても、ユーザーはアプリ設定から正確な通知を無効にすることができます。 checkExactNotificationSetting()を使用して設定の値を確認してください。 ユーザーがこの設定を無効にすると、アプリが再起動し、正確なアラームでスケジュールされた通知はすべて削除されます。 アプリケーションが正確なアラームに依存している場合は、アプリ起動時（たとえば、App.appStateChangeで）にこの設定を確認して、フォールバックまたは代替動作を提供してください。
Android 14には、USE_EXACT_ALARMという新しいパーミッションがあります。 ユーザーからパーミッションを要求することなく、正確なアラームを使用するには、このパーミッションを使用します。これは、正確なアラームの使用がアプリの機能の中心となる場合にのみ使用する必要があります。このパーミッションの使用に関する詳細についてはこちらを参照してください。
設定
Androidでは、ローカル通知は次のオプションで設定できます。
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
smallIcon | 文字列 | 通知のデフォルトのステータスバーアイコンを設定します。 アイコンはアプリのres/drawableフォルダに配置する必要があります。 このオプションの値は、拡張子を除いたファイル名であるdrawableリソースIDにする必要があります。 Androidでのみ使用可能です。 | 1.0.0 |
iconColor | 文字列 | 通知のステータスバーアイコンのデフォルトの色を設定します。 Androidでのみ使用可能です。 | 1.0.0 |
sound | 文字列 | 通知のデフォルトの通知音を設定します。 Android 26以降では、デフォルトのチャネルサウンドを設定し、アプリがアンインストールされない限り変更できません。 音声ファイルが見つからない場合、Android 21～25ではデフォルトのシステムサウンドが再生され、Android 26以降ではサウンドは再生されません。 Androidでのみ使用可能です。 | 1.0.0 |
例
capacitor.config.json内
{
"plugins": {
"LocalNotifications": {
"smallIcon": "ic_stat_icon_config_sample",
"iconColor": "#488AFF",
"sound": "beep.wav"
}
}
}
capacitor.config.ts内
/// <reference types="@capacitor/local-notifications" />
import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {
plugins: {
LocalNotifications: {
smallIcon: "ic_stat_icon_config_sample",
iconColor: "#488AFF",
sound: "beep.wav",
},
},
};
export default config;
Doze
デバイスがDozeモードに入った場合、アプリケーションの機能が制限される可能性があります。 Dozeモード中でも通知を発火させる必要がある場合は、allowWhileIdle: trueを使用して通知をスケジュールします。これらの通知はアプリごとに9分間に1回のみ発火できますので、allowWhileIdleは慎重に使用してください。
API
schedule(...)getPending()registerActionTypes(...)cancel(...)areEnabled()getDeliveredNotifications()removeDeliveredNotifications(...)removeAllDeliveredNotifications()createChannel(...)deleteChannel(...)listChannels()checkPermissions()requestPermissions()changeExactNotificationSetting()checkExactNotificationSetting()addListener('localNotificationReceived', ...)addListener('localNotificationActionPerformed', ...)removeAllListeners()- インターフェース
- 型エイリアス
- 列挙型
schedule(...)
schedule(options: ScheduleOptions) => Promise<ScheduleResult>
スケジュール 1つ以上のローカル通知。
| パラメータ | タイプ |
|---|---|
options | ScheduleOptions |
戻り値: Promise<ScheduleResult>
追加バージョン 1.0.0
getPending()
getPending() => Promise<PendingResult>
保留中の通知のリストを取得します。
戻り値: Promise<PendingResult>
追加バージョン 1.0.0
registerActionTypes(...)
registerActionTypes(options: RegisterActionTypesOptions) => Promise<void>
通知が表示されたときに実行するアクションを登録します。
iOSとAndroidでのみ使用可能です。
| パラメータ | タイプ |
|---|---|
options | RegisterActionTypesOptions |
追加バージョン 1.0.0
cancel(...)
cancel(options: CancelOptions) => Promise<void>
保留中の通知をキャンセルします。
| パラメータ | タイプ |
|---|---|
options | CancelOptions |
追加バージョン 1.0.0
areEnabled()
areEnabled() => Promise<EnabledResult>
通知が有効かどうかを確認します。
戻り値: Promise<EnabledResult>
追加バージョン 1.0.0
getDeliveredNotifications()
getDeliveredNotifications() => Promise<DeliveredNotifications>
通知画面に表示されている通知のリストを取得します。
戻り値: Promise<DeliveredNotifications>
追加バージョン 4.0.0
removeDeliveredNotifications(...)
removeDeliveredNotifications(delivered: DeliveredNotifications) => Promise<void>
指定した通知を通知画面から削除します。
| パラメータ | タイプ |
|---|---|
delivered | DeliveredNotifications |
追加バージョン 4.0.0
removeAllDeliveredNotifications()
removeAllDeliveredNotifications() => Promise<void>
通知画面からすべての通知を削除します。
追加バージョン 4.0.0
createChannel(...)
createChannel(channel: Channel) => Promise<void>
通知チャネルを作成します。
Androidでのみ使用可能です。
| パラメータ | タイプ |
|---|---|
channel | Channel |
追加バージョン 1.0.0
deleteChannel(...)
deleteChannel(args: { id: string; }) => Promise<void>
通知チャネルを削除します。
Androidでのみ使用可能です。
| パラメータ | タイプ |
|---|---|
引数 | { id: 文字列; } |
追加バージョン 1.0.0
listChannels()
listChannels() => Promise<ListChannelsResult>
通知チャネルのリストを取得します。
Androidでのみ使用可能です。
戻り値: Promise<ListChannelsResult>
追加バージョン 1.0.0
checkPermissions()
checkPermissions() => Promise<PermissionStatus>
ローカル通知を表示するためのパーミッションを確認します。
戻り値: Promise<PermissionStatus>
追加バージョン 1.0.0
requestPermissions()
requestPermissions() => Promise<PermissionStatus>
ローカル通知を表示するためのパーミッションを要求します。
戻り値: Promise<PermissionStatus>
追加バージョン 1.0.0
changeExactNotificationSetting()
changeExactNotificationSetting() => Promise<SettingsPermissionStatus>
ユーザーをアプリケーション設定画面に誘導して、正確なアラームを設定します。
ユーザーが設定を許可済みから拒否済みへ変更した場合、アプリケーションは再起動し、正確なアラームでスケジュールされた通知はすべて削除されます。
Android 12より前のバージョンでは、ユーザーはアプリケーション設定画面に誘導されず、この関数は許可済みを返します。
Androidでのみ使用可能です。
戻り値: Promise<SettingsPermissionStatus>
追加バージョン 6.0.0
checkExactNotificationSetting()
checkExactNotificationSetting() => Promise<SettingsPermissionStatus>
正確なアラームの使用に関するアプリケーション設定を確認します。
Androidでのみ使用可能です。
戻り値: Promise<SettingsPermissionStatus>
追加バージョン 6.0.0
addListener('localNotificationReceived', ...)
addListener(eventName: 'localNotificationReceived', listenerFunc: (notification: LocalNotificationSchema) => void) => Promise<PluginListenerHandle>
通知が表示されたときにリスンします。
| パラメータ | タイプ |
|---|---|
イベント名 | 'localNotificationReceived' |
リスナー関数 | (notification: LocalNotificationSchema) => void |
戻り値: Promise<PluginListenerHandle>
追加バージョン 1.0.0
addListener('localNotificationActionPerformed', ...)
addListener(eventName: 'localNotificationActionPerformed', listenerFunc: (notificationAction: ActionPerformed) => void) => Promise<PluginListenerHandle>
通知でアクションが実行されたときにリスンします。
| パラメータ | タイプ |
|---|---|
イベント名 | 'localNotificationActionPerformed' |
リスナー関数 | (notificationAction: ActionPerformed) => void |
戻り値: Promise<PluginListenerHandle>
追加バージョン 1.0.0
removeAllListeners()
removeAllListeners() => Promise<void>
このプラグインのすべてのリスナーを削除します。
追加バージョン 1.0.0
インターフェース
ScheduleResult
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
通知 | LocalNotificationDescriptor[] | スケジュールされた通知のリストです。 | 1.0.0 |
LocalNotificationDescriptor
ローカル通知を記述するオブジェクトです。
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
id | 番号 | 通知識別子です。 | 1.0.0 |
ScheduleOptions
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
通知 | LocalNotificationSchema[] | スケジュールする通知のリストです。 | 1.0.0 |
LocalNotificationSchema
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
タイトル | 文字列 | 通知のタイトルです。 | 1.0.0 |
本文 | 文字列 | 通知の本文です。タイトルの下に表示されます。 | 1.0.0 |
largeBody | 文字列 | 大きなテキスト通知スタイルで表示するための複数行のテキストブロックを設定します。 | 1.0.0 |
summaryText | 文字列 | インボックスと大きなテキスト通知スタイルでサマリーテキストの詳細を設定するために使用されます。Androidでのみ使用可能です。 | 1.0.0 |
id | 番号 | 通知識別子です。Androidでは32ビットの整数です。そのため、値は-2147483648から2147483647の範囲内である必要があります。 | 1.0.0 |
スケジュール | スケジュール | スケジュールこの通知を後で実行します。 | 1.0.0 |
sound | 文字列 | この通知が表示されたときに再生するオーディオファイルの名前です。ファイル名に拡張子を含めてください。iOSでは、ファイルはアプリバンドル内に存在する必要があります。Androidでは、ファイルはres/rawフォルダ内に存在する必要があります。iOSとAndroidの両方でサポートされているため、推奨される形式は.wavです。iOSとAndroid < 26でのみ使用可能です。Android 26以降は、目的の音声で設定されたチャネルのchannelIdを使用してください。音声ファイルが見つからない場合（つまり、空の文字列または間違った名前）、デフォルトのシステム通知音が使用されます。指定されていない場合、Androidではデフォルトの音声が、iOSでは音声が鳴りません。 | 1.0.0 |
smallIcon | 文字列 | カスタムステータスバーアイコンを設定します。設定した場合、Capacitor設定のsmallIconオプションを上書きします。アイコンはアプリのres/drawableフォルダに配置する必要があります。このオプションの値は、拡張子を除いたファイル名であるdrawableリソースIDである必要があります。Androidでのみ使用可能です。 | 1.0.0 |
largeIcon | 文字列 | 通知の大きなアイコンを設定します。アイコンはアプリのres/drawableフォルダに配置する必要があります。このオプションの値は、拡張子を除いたファイル名であるdrawableリソースIDである必要があります。Androidでのみ使用可能です。 | 1.0.0 |
iconColor | 文字列 | 通知アイコンの色を設定します。Androidでのみ使用可能です。 | 1.0.0 |
添付ファイル | Attachment[] | この通知に添付ファイルを設定します。 | 1.0.0 |
actionTypeId | 文字列 | この通知にアクションタイプを関連付けます。 | 1.0.0 |
extra | 任意 | この通知内に格納する追加データを設定します。 | 1.0.0 |
threadIdentifier | 文字列 | 複数の通知をグループ化するために使用されます。UNMutableNotificationContentにthreadIdentifierを設定します。iOSでのみ使用可能です。 | 1.0.0 |
summaryArgument | 文字列 | この通知がカテゴリのサマリー形式文字列に追加する文字列です。UNMutableNotificationContentにsummaryArgumentを設定します。iOSでのみ使用可能です。 | 1.0.0 |
グループ | 文字列 | 複数の通知をグループ化するために使用されます。指定された値を使用してNotificationCompat.BuilderでsetGroup()を呼び出します。Androidでのみ使用可能です。 | 1.0.0 |
groupSummary | boolean | trueの場合、この通知は通知グループのサマリーになります。指定された値を使用してNotificationCompat.BuilderでsetGroupSummary()を呼び出します。groupを使用する場合、Androidでのみ使用可能です。 | 1.0.0 |
channelId | 文字列 | 通知を送信するチャネルを指定します。指定された名前のチャネルが存在しない場合、通知は発生しません。指定されていない場合、デフォルトのチャネルを使用します。指定された値を使用してNotificationCompat.BuilderでsetChannelId()を呼び出します。Android 26以降でのみ使用可能です。 | 1.0.0 |
継続中 | boolean | trueの場合、通知をスワイプで削除できません。指定された値を使用してNotificationCompat.BuilderでsetOngoing()を呼び出します。Androidでのみ使用可能です。 | 1.0.0 |
自動キャンセル | boolean | trueの場合、ユーザーが通知をクリックすると通知がキャンセルされます。指定された値を使用してNotificationCompat.BuilderでsetAutoCancel()を呼び出します。Androidでのみ使用可能です。 | 1.0.0 |
inboxList | string[] | インボックススタイルの通知に表示する文字列のリストを設定します。最大5つの文字列が許可されます。Androidでのみ使用可能です。 | 1.0.0 |
サイレント | boolean | trueの場合、アプリがフォアグラウンドにある間は通知は表示されません。iOSでのみ使用可能です。 | 5.0.0 |
スケジュール
通知のスケジュールを表します。
通知をスケジュールするには、at、on、またはeveryのいずれかを使用します。
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
at | 日付 | スケジュール特定の日時で通知をスケジュールします。 | 1.0.0 |
繰り返し | boolean | atで指定された日時でこの通知の配信を繰り返します。iOSとAndroidでのみ使用可能です。 | 1.0.0 |
allowWhileIdle | boolean | Doze中にこの通知を発生させることを許可します。Android 23以降でのみ使用可能です。これらの通知は、アプリごとに9分間に1回のみ発生させることができます。 | 1.0.0 |
on | ScheduleOn | スケジュール特定の間隔で通知をスケジュールします。これは、cronジョブのスケジュールに似ています。iOSとAndroidでのみ使用可能です。 | 1.0.0 |
every | ScheduleEvery | スケジュール特定の間隔で通知をスケジュールします。 | 1.0.0 |
回数 | 番号 | everyで指定された間隔で配信される通知の回数を制限します。 | 1.0.0 |
日付
日付と時刻の基本的な保存と取得を有効にします。
| メソッド | シグネチャ | 説明 |
|---|---|---|
| toString | () => string | 日付の文字列表現を返します。文字列の形式はロケールによって異なります。 |
| toDateString | () => string | 日付を文字列値として返します。 |
| toTimeString | () => string | 時刻を文字列値として返します。 |
| toLocaleString | () => string | ホスト環境の現在のロケールに適した文字列値として値を返します。 |
| toLocaleDateString | () => string | ホスト環境の現在のロケールに適した文字列値として日付を返します。 |
| toLocaleTimeString | () => string | ホスト環境の現在のロケールに適した文字列値として時刻を返します。 |
| valueOf | () => number | 1970年1月1日午前0時からのミリ秒単位で格納された時刻値を返します。 |
| getTime | () => number | ミリ秒単位の時刻値を取得します。 |
| getFullYear | () => number | ローカル時刻を使用して年を取得します。 |
| getUTCFullYear | () => number | 協定世界時（UTC）を使用して年を取得します。 |
| getMonth | () => number | ローカル時刻を使用して月を取得します。 |
| getUTCMonth | () => number | 協定世界時（UTC）を使用してDateオブジェクトの月を取得します。 |
| getDate | () => number | ローカル時刻を使用して月の曜日を取得します。 |
| getUTCDate | () => number | 協定世界時（UTC）を使用して月の曜日を取得します。 |
| getDay | () => number | ローカル時刻を使用して曜日の番号を取得します。 |
| getUTCDay | () => number | 協定世界時（UTC）を使用して曜日の番号を取得します。 |
| getHours | () => number | ローカル時刻を使用して日付の時を取得します。 |
| getUTCHours | () => number | 協定世界時（UTC）を使用してDateオブジェクトの時を取得します。 |
| getMinutes | () => number | ローカル時刻を使用してDateオブジェクトの分を取得します。 |
| getUTCMinutes | () => number | 協定世界時（UTC）を使用してDateオブジェクトの分を取得します。 |
| getSeconds | () => number | ローカル時刻を使用してDateオブジェクトの秒を取得します。 |
| getUTCSeconds | () => number | 協定世界時（UTC）を使用してDateオブジェクトの秒を取得します。 |
| getMilliseconds | () => number | ローカル時刻を使用してDateのミリ秒を取得します。 |
| getUTCMilliseconds | () => number | 協定世界時（UTC）を使用してDateオブジェクトのミリ秒を取得します。 |
| getTimezoneOffset | () => number | ローカルコンピューターの時刻と協定世界時（UTC）との間の分単位の差を取得します。 |
| setTime | (time: number) => number | Dateオブジェクトの日時値を設定します。 |
| setMilliseconds | (ms: number) => number | ローカル時刻を使用してDateオブジェクトのミリ秒値を設定します。 |
| setUTCMilliseconds | (ms: number) => number | 協定世界時（UTC）を使用してDateオブジェクトのミリ秒値を設定します。 |
| setSeconds | (sec: number, ms?: number | undefined) => number | ローカル時刻を使用してDateオブジェクトの秒値を設定します。 |
| setUTCSeconds | (sec: number, ms?: number | undefined) => number | 協定世界時（UTC）を使用してDateオブジェクトの秒値を設定します。 |
| setMinutes | (min: number, sec?: number | undefined, ms?: number | undefined) => number | ローカル時刻を使用してDateオブジェクトの分値を設定します。 |
| setUTCMinutes | (min: number, sec?: number | undefined, ms?: number | undefined) => number | 協定世界時（UTC）を使用してDateオブジェクトの分値を設定します。 |
| setHours | (hours: number, min?: number | undefined, sec?: number | undefined, ms?: number | undefined) => number | ローカル時刻を使用してDateオブジェクトの時値を設定します。 |
| setUTCHours | (hours: number, min?: number | undefined, sec?: number | undefined, ms?: number | undefined) => number | 協定世界時（UTC）を使用してDateオブジェクトの時値を設定します。 |
| setDate | (date: number) => number | ローカル時刻を使用してDateオブジェクトの数値月の曜日値を設定します。 |
| setUTCDate | (date: number) => number | 協定世界時（UTC）を使用してDateオブジェクトの数値月の曜日を設定します。 |
| setMonth | (month: number, date?: number | undefined) => number | ローカル時刻を使用してDateオブジェクトの月値を設定します。 |
| setUTCMonth | (month: number, date?: number | undefined) => number | 協定世界時（UTC）を使用してDateオブジェクトの月値を設定します。 |
| setFullYear | (year: number, month?: number | undefined, date?: number | undefined) => number | ローカルタイムを使用して、Dateオブジェクトの年を設定します。 |
| setUTCFullYear | (year: number, month?: number | undefined, date?: number | undefined) => number | 協定世界時（UTC）を使用して、Dateオブジェクトの年値を設定します。 |
| toUTCString | () => string | 協定世界時（UTC）を使用して文字列に変換された日付を返します。 |
| toISOString | () => string | ISO形式の文字列値として日付を返します。 |
| toJSON | (key?: any) => string | JSON.stringifyメソッドで使用され、JavaScriptオブジェクト表記（JSON）シリアル化のためにオブジェクトのデータを変換できるようにします。 |
ScheduleOn
| プロパティ | タイプ |
|---|---|
年 | 番号 |
月 | 番号 |
日 | 番号 |
曜日 | 曜日 |
時 | 番号 |
分 | 番号 |
秒 | 番号 |
Attachment
通知の添付ファイルを表現します。
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
id | 文字列 | 添付ファイル識別子。 | 1.0.0 |
url | 文字列 | 添付ファイルへのURL。ウェブアセットを参照するには`res`スキームを使用します（例：`res:///assets/img/icon.png`）。`file` URLも受け付けます。 | 1.0.0 |
options | AttachmentOptions | Attachment オプション。 | 1.0.0 |
AttachmentOptions
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
iosUNNotificationAttachmentOptionsTypeHintKey | 文字列 | UNNotificationAttachmentのハッシュ可能なオプションにUNNotificationAttachmentOptionsTypeHintKeyキーを設定します。iOSのみで利用可能です。 | 1.0.0 |
iosUNNotificationAttachmentOptionsThumbnailHiddenKey | 文字列 | UNNotificationAttachmentのハッシュ可能なオプションにUNNotificationAttachmentOptionsThumbnailHiddenKeyキーを設定します。iOSのみで利用可能です。 | 1.0.0 |
iosUNNotificationAttachmentOptionsThumbnailClippingRectKey | 文字列 | UNNotificationAttachmentのハッシュ可能なオプションにUNNotificationAttachmentOptionsThumbnailClippingRectKeyキーを設定します。iOSのみで利用可能です。 | 1.0.0 |
iosUNNotificationAttachmentOptionsThumbnailTimeKey | 文字列 | UNNotificationAttachmentのハッシュ可能なオプションにUNNotificationAttachmentOptionsThumbnailTimeKeyキーを設定します。iOSのみで利用可能です。 | 1.0.0 |
PendingResult
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
通知 | PendingLocalNotificationSchema[] | 保留中の通知のリスト。 | 1.0.0 |
PendingLocalNotificationSchema
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
タイトル | 文字列 | 通知のタイトルです。 | 1.0.0 |
本文 | 文字列 | 通知の本文です。タイトルの下に表示されます。 | 1.0.0 |
id | 番号 | 通知識別子です。 | 1.0.0 |
スケジュール | スケジュール | スケジュールこの通知を後で実行します。 | 1.0.0 |
extra | 任意 | この通知内に格納する追加データを設定します。 | 1.0.0 |
RegisterActionTypesOptions
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
types | ActionType[] | 登録するアクションタイプのリスト。 | 1.0.0 |
ActionType
アクションのコレクション。
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
id | 文字列 | アクションタイプのID。通知では`actionTypeId`キーで参照されます。 | 1.0.0 |
actions | Action[] | このアクションタイプに関連付けられたアクションのリスト。 | 1.0.0 |
iosHiddenPreviewsBodyPlaceholder | 文字列 | UNNotificationCategoryの`hiddenPreviewsBodyPlaceholder`を設定します。iOSのみで利用可能です。 | 1.0.0 |
iosCustomDismissAction | boolean | UNNotificationCategoryのオプションに`customDismissAction`を設定します。iOSのみで利用可能です。 | 1.0.0 |
iosAllowInCarPlay | boolean | UNNotificationCategoryのオプションに`allowInCarPlay`を設定します。iOSのみで利用可能です。 | 1.0.0 |
iosHiddenPreviewsShowTitle | boolean | UNNotificationCategoryのオプションに`hiddenPreviewsShowTitle`を設定します。iOSのみで利用可能です。 | 1.0.0 |
iosHiddenPreviewsShowSubtitle | boolean | UNNotificationCategoryのオプションに`hiddenPreviewsShowSubtitle`を設定します。iOSのみで利用可能です。 | 1.0.0 |
Action
通知が表示されたときに実行できるアクション。
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
id | 文字列 | アクション識別子。`'actionPerformed'`イベントでは`actionId`として参照されます。 | 1.0.0 |
タイトル | 文字列 | このアクションに表示するタイトルテキスト。 | 1.0.0 |
requiresAuthentication | boolean | UNNotificationActionのオプションに`authenticationRequired`を設定します。iOSのみで利用可能です。 | 1.0.0 |
foreground | boolean | UNNotificationActionのオプションに`foreground`を設定します。iOSのみで利用可能です。 | 1.0.0 |
destructive | boolean | UNNotificationActionのオプションに`destructive`を設定します。iOSのみで利用可能です。 | 1.0.0 |
input | boolean | UNNotificationActionの代わりにUNTextInputNotificationActionを使用してください。iOSのみで利用可能です。 | 1.0.0 |
inputButtonTitle | 文字列 | UNTextInputNotificationActionに`textInputButtonTitle`を設定します。`input`が`true`の場合、iOSのみで利用可能です。 | 1.0.0 |
inputPlaceholder | 文字列 | UNTextInputNotificationActionに`textInputPlaceholder`を設定します。`input`が`true`の場合、iOSのみで利用可能です。 | 1.0.0 |
CancelOptions
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
通知 | LocalNotificationDescriptor[] | キャンセルする通知のリスト。 | 1.0.0 |
EnabledResult
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
value | boolean | デバイスでローカル通知が有効になっているかどうか。 | 1.0.0 |
DeliveredNotifications
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
通知 | DeliveredNotificationSchema[] | 通知画面に表示されている通知のリスト。 | 1.0.0 |
DeliveredNotificationSchema
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
id | 番号 | 通知識別子です。 | 4.0.0 |
tag | 文字列 | 通知タグ。Androidのみで利用可能です。 | 4.0.0 |
タイトル | 文字列 | 通知のタイトルです。 | 4.0.0 |
本文 | 文字列 | 通知の本文です。タイトルの下に表示されます。 | 4.0.0 |
グループ | 文字列 | 設定された通知グループ。Androidのみで利用可能です。 | 4.0.0 |
groupSummary | boolean | この通知が通知グループのサマリーかどうか。Androidのみで利用可能です。 | 4.0.0 |
data | 任意 | 通知ペイロードに含まれていた追加データ。Androidのみで利用可能です。 | 4.0.0 |
extra | 任意 | この通知内に保存する追加データ。iOSのみで利用可能です。 | 4.0.0 |
添付ファイル | Attachment[] | この通知の添付ファイル。iOSのみで利用可能です。 | 1.0.0 |
actionTypeId | 文字列 | この通知に関連付けられたActionタイプ。iOSのみで利用可能です。 | 4.0.0 |
スケジュール | スケジュール | この通知を発生させるために使用されたSchedule。iOSのみで利用可能です。 | 4.0.0 |
sound | 文字列 | 通知が表示されたときに使用されたサウンド。iOSのみで利用可能です。 | 4.0.0 |
Channel
| プロパティ | タイプ | 説明 | デフォルト | 追加バージョン |
|---|---|---|---|---|
id | 文字列 | チャネル識別子。 | 1.0.0 | |
name | 文字列 | このチャネルのユーザーフレンドリーな名前（ユーザーに提示されます）。 | 1.0.0 | |
description | 文字列 | このチャネルの説明（ユーザーに提示されます）。 | 1.0.0 | |
sound | 文字列 | このチャネルに投稿された通知で再生するサウンド。重要度が少なくとも`3`の通知チャネルにはサウンドが必要です。サウンドファイルのファイル名は、Androidアプリの`res/raw`ディレクトリを基準とした相対パスで指定する必要があります。サウンドが提供されていない場合、またはサウンドファイルが見つからない場合は、サウンドは使用されません。 | 1.0.0 | |
importance | 重要度 | このチャネルに投稿された通知の中断レベル。 | | 1.0.0 |
visibility | 表示状態 | このチャネルに投稿された通知の表示状態。この設定は、このチャネルに投稿された通知がロック画面に表示されるかどうか、そして表示される場合、編集された形式で表示されるかどうかを決定します。 | 1.0.0 | |
lights | boolean | このチャネルに投稿された通知で通知ライトを表示するかどうか（対応するデバイスの場合）。 | 1.0.0 | |
lightColor | 文字列 | このチャネルに投稿された通知のライトの色。このチャネルでライトが有効になっていて、デバイスが対応している場合のみサポートされます。サポートされているカラー形式は`#RRGGBB`と`#RRGGBBAA`です。 | 1.0.0 | |
vibration | boolean | このチャネルに投稿された通知でバイブレーションを行うかどうか。 | 1.0.0 |
ListChannelsResult
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
channels | Channel[] | 通知チャネルのリスト。 | 1.0.0 |
PermissionStatus
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
display | PermissionState | 通知の表示のパーミッション状態。 | 1.0.0 |
SettingsPermissionStatus
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
exact_alarm | PermissionState | 正確なアラームの使用許可状態。 | 6.0.0 |
PluginListenerHandle
| プロパティ | タイプ |
|---|---|
remove | () => Promise<void> |
ActionPerformed
| プロパティ | タイプ | 説明 | 追加バージョン |
|---|---|---|---|
actionId | 文字列 | 実行されたアクションの識別子。 | 1.0.0 |
inputValue | 文字列 | ユーザーが通知に入力した値。`input`が`true`に設定されている通知の場合、iOSのみで利用可能です。 | 1.0.0 |
notification | LocalNotificationSchema | 元の通知スキーマ。 | 1.0.0 |
Type Aliases
ScheduleEvery
`year` | `month` | `two-weeks` | `week` | `day` | `hour` | `minute` | `second`Importance
重要度レベル。詳細については、Android Developer Docsを参照してください。
1 | 2 | 3 | 4 | 5Visibility
通知の表示状態。詳細については、Android Developer Docsを参照してください。
-1 | 0 | 1PermissionState
`prompt` | `prompt-with-rationale` | `granted` | `denied`Enums
Weekday
| メンバー | 値 |
|---|---|
日曜日 | 1 |
月曜日 | 2 |
火曜日 | 3 |
水曜日 | 4 |
木曜日 | 5 |
金曜日 | 6 |
土曜日 | 7 |