@capacitor/local-notifications

The Local Notifications API provides a way to schedule device notifications locally (i.e. without a server sending push notifications).

Install

npm install @capacitor/local-notifications
npx cap sync

Android

Android 13 requires a permission check in order to send notifications. You are required to call checkPermissions() and requestPermissions() accordingly.

On Android 12 and older it won't show a prompt and will just return as granted.

Starting on Android 12, scheduled notifications won't be exact unless this permission is added to your AndroidManifest.xml:

<uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" />

Note that even if the permission is present, users can still disable exact notifications from the app settings. Use checkExactNotificationSetting() to check the the value of the setting. If a user disables this setting, the app will restart and any notification scheduled with an exact alarm will be deleted. If your application depends on exact alarms, be sure to check this setting on app launch (for example, in App.appStateChange) in order to provide fallbacks or alternative behavior.

On Android 14, there is a new permission called USE_EXACT_ALARM. Use this permission to use exact alarms without needing to request permission from the user. This should only be used if the use of exact alarms is central to your app's functionality. Read more about the implications of using this permission here.

From Android 15 onwards, users can install an app in the Private space. Users can lock their private space at any time, which means that push notifications are not shown until the user unlocks it.

It is not possible to detect if an app is installed in the private space. Therefore, if your app shows any critical notifications, inform your users to avoid installing the app in the private space.

For more information about the behavior changes of your app related to the private space, refer to Android documentation.

Configuration

The Local Notifications can be configured with the following options:

| Prop | Type | Description | Since | | ------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | smallIcon | string | Set the default status bar icon for notifications. Icons should be placed in your app's res/drawable folder. The value for this option should be the drawable resource ID, which is the filename without an extension. Only available for Android. | 1.0.0 | | iconColor | string | Set the default color of status bar icons for notifications. Only available for Android. | 1.0.0 | | sound | string | Set the default notification sound for notifications. On Android 8+ it sets the default channel sound and can't be changed unless the app is uninstalled. If the audio file is not found, it will result in the default system sound being played on Android 7.x and no sound on Android 8+. Only available for Android. | 1.0.0 | | presentationOptions | LocalNotificationPresentationOption[] | This is an array of strings you can combine. Possible values in the array are: - badge: badge count on the app icon is updated (default value) - sound: the device will ring/vibrate when the notification is received - banner: the notification is displayed as a banner - list: the notification is displayed in the notification center An empty array can be provided if none of the options are desired. Only available for iOS. | 8.2.0 |

Examples

In capacitor.config.json:

{
  "plugins": {
    "LocalNotifications": {
      "smallIcon": "ic_stat_icon_config_sample",
      "iconColor": "#488AFF",
      "sound": "beep.wav",
      "presentationOptions": ["badge", "sound", "banner", "list"]
    }
  }
}

In 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",
      presentationOptions: ["badge", "sound", "banner", "list"],
    },
  },
};

export default config;

Doze

If the device has entered Doze mode, your application may have restricted capabilities. If you need your notification to fire even during Doze, schedule your notification by using allowWhileIdle: true. Make use of allowWhileIdle judiciously, as these notifications can only fire once per 9 minutes, per app.

Errors

Starting on version 8.3.0, the plugin returns structured errors on Android and iOS. Each error has a code (e.g. OS-PLUG-LNOT-0001) and a message with a human-readable description. Codes 0001, 0002, 0005, 0006, 0011 and 0012 mean the same thing on both platforms; every other code is platform-specific.

| Error code | Platform(s) | Description | |---|---|---| | OS-PLUG-LNOT-0001 | Android, iOS | Must provide a notifications array as the notifications option. | | OS-PLUG-LNOT-0002 | Android, iOS | Notification is missing an identifier. | | OS-PLUG-LNOT-0003 | iOS | Unable to build the notification content. | | OS-PLUG-LNOT-0004 | iOS | Unable to create the notification, trigger construction failed. | | OS-PLUG-LNOT-0005 | Android, iOS | Notifications are not enabled on this device. | | OS-PLUG-LNOT-0006 | Android, iOS | Invalid color provided. Must be a hex string (e.g. #ff0000). | | OS-PLUG-LNOT-0007 | Android | Provided notification format is invalid. | | OS-PLUG-LNOT-0008 | Android | Invalid date format sent to the plugin. | | OS-PLUG-LNOT-0009 | Android | The identifier must be a 32-bit integer. | | OS-PLUG-LNOT-0010 | iOS | Unable to schedule the notification. | | OS-PLUG-LNOT-0011 | Android, iOS | Expected notifications to be a list of notification objects. | | OS-PLUG-LNOT-0012 | Android, iOS | Must provide an ids array. | | OS-PLUG-LNOT-0013 | iOS | Unable to request notification permission. | | OS-PLUG-LNOT-0014 | Android | Invalid JSON object sent to the plugin. | | OS-PLUG-LNOT-0015 | Android | Channel is missing an identifier. | | OS-PLUG-LNOT-0016 | Android | Channel is missing a name. | | OS-PLUG-LNOT-0017 | Android | Unable to schedule an exact alarm due to lack of permissions. Scheduled as an inexact alarm instead. | | OS-PLUG-LNOT-0018 | Android | Unable to schedule an exact alarm due to lack of permissions. |

API

• schedule(...)
• update(...)
• getPending()
• registerActionTypes(...)
• cancel(...)
• cancelAll()
• areEnabled()
• getDeliveredNotifications()
• removeDeliveredNotifications(...)
• removeDeliveredNotificationsById(...)
• removeAllDeliveredNotifications()
• getByIds(...)
• getAll(...)
• createChannel(...)
• deleteChannel(...)
• listChannels()
• checkPermissions()
• requestPermissions()
• changeExactNotificationSetting()
• checkExactNotificationSetting()
• addListener('localNotificationReceived', ...)
• addListener('localNotificationActionPerformed', ...)
• removeAllListeners()
• Interfaces
• Type Aliases
• Enums

schedule(...)

schedule(options: ScheduleOptions) => Promise<ScheduleResult>

Schedule one or more local notifications.

Starting on version 8.3.0 this requests the notification permission it needs before scheduling if it has not been granted yet (Android 13+ POST_NOTIFICATIONS, iOS UNUserNotificationCenter authorization). Apps that already call requestPermissions() beforehand are unaffected.

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | ScheduleOptions |

Returns: Promise<ScheduleResult>

Since: 1.0.0

update(...)

update(options: ScheduleOptions) => Promise<ScheduleResult>

Update one or more previously scheduled local notifications, matched by id.

Notifications whose id is not currently scheduled are ignored. Like schedule, this requests the notification permission if needed.

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | ScheduleOptions |

Returns: Promise<ScheduleResult>

Since: 8.3.0

getPending()

getPending() => Promise<PendingResult>

Get a list of pending notifications.

Returns: Promise<PendingResult>

Since: 1.0.0

registerActionTypes(...)

registerActionTypes(options: RegisterActionTypesOptions) => Promise<void>

Register actions to take when notifications are displayed.

Only available for iOS and Android.

| Param | Type | | ------------- | --------------------------------------------------------------------------------- | | options | RegisterActionTypesOptions |

Since: 1.0.0

cancel(...)

cancel(options: CancelOptions) => Promise<void>

Cancel pending notifications.

| Param | Type | | ------------- | ------------------------------------------------------- | | options | CancelOptions |

Since: 1.0.0

cancelAll()

cancelAll() => Promise<void>

Cancel all pending (scheduled) notifications.

Since: 8.3.0

areEnabled()

areEnabled() => Promise<EnabledResult>

Check if notifications are enabled or not.

Returns: Promise<EnabledResult>

Since: 1.0.0

getDeliveredNotifications()

getDeliveredNotifications() => Promise<DeliveredNotifications>

Get a list of notifications that are visible on the notifications screen.

Returns: Promise<DeliveredNotifications>

Since: 4.0.0

removeDeliveredNotifications(...)

removeDeliveredNotifications(delivered: DeliveredNotifications) => Promise<void>

Remove the specified notifications from the notifications screen.

| Param | Type | | --------------- | ------------------------------------------------------------------------- | | delivered | DeliveredNotifications |

Since: 4.0.0

removeDeliveredNotificationsById(...)

removeDeliveredNotificationsById(options: RemoveByIdsOptions) => Promise<void>

Remove the specified delivered notifications from the notifications screen, matched by id.

Id-based counterpart of removeDeliveredNotifications, so callers that only have identifiers (e.g. the OutSystems ClearNotifications action) can map to a single method call.

| Param | Type | | ------------- | ----------------------------------------------------------------- | | options | RemoveByIdsOptions |

Since: 8.3.0

removeAllDeliveredNotifications()

removeAllDeliveredNotifications() => Promise<void>

Remove all the notifications from the notifications screen.

Since: 4.0.0

getByIds(...)

getByIds(options: GetByIdsOptions) => Promise<GetNotificationsResult>

Get the notifications matching the supplied identifiers, whether they are still scheduled (pending) or already delivered.

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | GetByIdsOptions |

Returns: Promise<GetNotificationsResult>

Since: 8.3.0

getAll(...)

getAll(options?: GetAllOptions | undefined) => Promise<GetNotificationsResult>

Get all notifications known to the plugin, optionally filtered by state.

When state is omitted both scheduled and delivered notifications are returned. SCHEDULED returns pending notifications; TRIGGERED returns delivered notifications.

| Param | Type | | ------------- | ------------------------------------------------------- | | options | GetAllOptions |

Returns: Promise<GetNotificationsResult>

Since: 8.3.0

createChannel(...)

createChannel(channel: Channel) => Promise<void>

Create a notification channel.

Only available for Android.

| Param | Type | | ------------- | ------------------------------------------- | | channel | Channel |

Since: 1.0.0

deleteChannel(...)

deleteChannel(args: { id: string; }) => Promise<void>

Delete a notification channel.

Only available for Android.

| Param | Type | | ---------- | ---------------------------- | | args | { id: string; } |

Since: 1.0.0

listChannels()

listChannels() => Promise<ListChannelsResult>

Get a list of notification channels.

Only available for Android.

Returns: Promise<ListChannelsResult>

Since: 1.0.0

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Check permission to display local notifications.

Returns: Promise<PermissionStatus>

Since: 1.0.0

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Request permission to display local notifications.

Returns: Promise<PermissionStatus>

Since: 1.0.0

changeExactNotificationSetting()

changeExactNotificationSetting() => Promise<SettingsPermissionStatus>

Direct user to the application settings screen to configure exact alarms.

In the event that a user changes the settings from granted to denied, the application will restart and any notification scheduled with an exact alarm will be deleted.

On Android < 12, the user will NOT be directed to the application settings screen, instead this function will return granted.

Only available on Android.

Returns: Promise<SettingsPermissionStatus>

Since: 6.0.0

checkExactNotificationSetting()

checkExactNotificationSetting() => Promise<SettingsPermissionStatus>

Check application setting for using exact alarms.

Only available on Android.

Returns: Promise<SettingsPermissionStatus>

Since: 6.0.0

addListener('localNotificationReceived', ...)

addListener(eventName: 'localNotificationReceived', listenerFunc: (notification: LocalNotificationSchema) => void) => Promise<PluginListenerHandle>

Listen for when notifications are displayed.

| Param | Type | | ------------------ | ------------------------------------------------------------------------------------------------------ | | eventName | 'localNotificationReceived' | | listenerFunc | (notification: LocalNotificationSchema) => void |

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('localNotificationActionPerformed', ...)

addListener(eventName: 'localNotificationActionPerformed', listenerFunc: (notificationAction: ActionPerformed) => void) => Promise<PluginListenerHandle>

Listen for when an action is performed on a notification.

| Param | Type | | ------------------ | -------------------------------------------------------------------------------------------- | | eventName | 'localNotificationActionPerformed' | | listenerFunc | (notificationAction: ActionPerformed) => void |

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 1.0.0

Interfaces

ScheduleResult

| Prop | Type | Description | Since | | ------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | notifications | LocalNotificationDescriptor[] | The list of scheduled notifications. | 1.0.0 | | warning | ScheduleWarning | Set when at least one notification in this call had isExactNotification true (the default) but the exact-alarm permission was not granted: it was scheduled as an inexact alarm instead. Absent on update() calls and whenever every applicable notification got its requested exactness. | 8.3.0 |

LocalNotificationDescriptor

The object that describes a local notification.

| Prop | Type | Description | Since | | -------- | ------------------- | ---------------------------- | ----- | | id | number | The notification identifier. | 1.0.0 |

ScheduleWarning

A non-fatal warning returned alongside a successful result.

| Prop | Type | Description | Since | | ------------- | ------------------- | -------------------------------------------- | ----- | | code | string | The OS-PLUG-LNOT-NNNN warning code. | 8.3.0 | | message | string | A human-readable description of the warning. | 8.3.0 |

ScheduleOptions

| Prop | Type | Description | Since | | ------------------- | -------------------------------------- | -------------------------------------- | ----- | | notifications | LocalNotificationSchema[] | The list of notifications to schedule. | 1.0.0 |

LocalNotificationSchema

| Prop | Type | Description | Default | Since | | ------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- | | title | string | The title of the notification. | | 1.0.0 | | body | string | The body of the notification, shown below the title. | | 1.0.0 | | largeBody | string | Sets a multiline text block for display in a big text notification style. | | 1.0.0 | | summaryText | string | Used to set the summary text detail in inbox and big text notification styles. Only available for Android. | | 1.0.0 | | id | number | The notification identifier. On Android it's a 32-bit int. So the value should be between -2147483648 and 2147483647 inclusive. | | 1.0.0 | | schedule | Schedule | Schedule this notification for a later time. | | 1.0.0 | | sound | string | Name of the audio file to play when this notification is displayed. Include the file extension with the filename. On iOS, the file should be in the app bundle. On Android, the file should be in res/raw folder. Recommended format is .wav because is supported by both iOS and Android. Only available for iOS and Android 7.x. For Android 8+ use channelId of a channel configured with the desired sound. If the sound file is not found, (i.e. empty string or wrong name) the default system notification sound will be used. If not provided, it will produce the default sound on Android and no sound on iOS. | | 1.0.0 | | smallIcon | string | Set a custom status bar icon. If set, this overrides the smallIcon option from Capacitor configuration. Icons should be placed in your app's res/drawable folder. The value for this option should be the drawable resource ID, which is the filename without an extension. Only available for Android. | | 1.0.0 | | largeIcon | string | Set a large icon for notifications. Icons should be placed in your app's res/drawable folder. The value for this option should be the drawable resource ID, which is the filename without an extension. Only available for Android. | | 1.0.0 | | iconColor | string | Set the color of the notification icon. Only available for Android. | | 1.0.0 | | attachments | Attachment[] | Set attachments for this notification. | | 1.0.0 | | actionTypeId | string | Associate an action type with this notification. | | 1.0.0 | | extra | any | Set extra data to store within this notification. | | 1.0.0 | | threadIdentifier | string | Used to group multiple notifications. Sets threadIdentifier on the UNMutableNotificationContent. Only available for iOS. | | 1.0.0 | | summaryArgument | string | The string this notification adds to the category's summary format string. Sets summaryArgument on the UNMutableNotificationContent. Only available for iOS. | | 1.0.0 | | relevanceScore | number | The score the system uses to determine if the notification is the featured notification when the system groups the app's notifications. The value must be between 0 and 1, where 0 is the least relevant and 1 is the most relevant. The default value is 0. Sets relevanceScore on the UNMutableNotificationContent. Only available for iOS. | | 8.1.0 | | interruptionLevel | InterruptionLevel | The interruption level that indicates the priority and delivery timing of a notification. Sets interruptionLevel on the UNMutableNotificationContent. Only available for iOS. | | 8.1.0 | | group | string | Used to group multiple notifications. Calls setGroup() on NotificationCompat.Builder with the provided value. Only available for Android. | | 1.0.0 | | groupSummary | boolean | If true, this notification becomes the summary for a group of notifications. Calls setGroupSummary() on NotificationCompat.Builder with the provided value. Only available for Android when using group. | | 1.0.0 | | channelId | string | Specifies the channel the notification should be delivered on. If channel with the given name does not exist then the notification will not fire. If not provided, it will use the default channel. Calls setChannelId() on NotificationCompat.Builder with the provided value. Only available for Android 8+. | | 1.0.0 | | ongoing | boolean | If true, the notification can't be swiped away. Calls setOngoing() on NotificationCompat.Builder with the provided value. Only available for Android. | | 1.0.0 | | autoCancel | boolean | If true, the notification is canceled when the user clicks on it. Calls setAutoCancel() on NotificationCompat.Builder with the provided value. Only available for Android. | | 1.0.0 | | inboxList | string[] | Sets a list of strings for display in an inbox style notification. Up to 5 strings are allowed. Only available for Android. | | 1.0.0 | | silent | boolean | If true, notification will not appear while app is in the foreground. Only available for iOS. | | 5.0.0 | | badge | number | The number to display on the app icon badge when this notification is delivered. On iOS this sets the badge count on the UNMutableNotificationContent. On Android this calls setNumber() on NotificationCompat.Builder. | | 8.3.0 | | foreground | boolean | Whether the notification should be presented while the app is in the foreground. On iOS true forces the notification to be shown even while the app is foregrounded, while false suppresses it (it is still delivered to the localNotificationReceived listener). This is independent of silent; when both are provided, foreground takes precedence. On Android it raises the notification priority so it can present as a heads-up notification. | | 8.3.0 | | isExactNotification | boolean | Whether this notification should be scheduled with an exact alarm. Only available for Android. Defaults to true: on schedule() (API 31+), if the app isn't yet allowed to schedule exact alarms the system "Alarms & reminders" settings screen is opened so the user can grant it — regardless of isExactMandatory. If the user still declines, the notification falls back to an inexact alarm (unless isExactMandatory is also set, in which case the call is rejected instead); a fallback like this sets ScheduleResult.warning. update() never prompts and falls back silently. Set to false to schedule this notification as inexact outright, regardless of permission state. | true | 8.3.0 | | isExactMandatory | boolean | Whether an exact alarm is mandatory for this notification. Only available for Android, and only meaningful when isExactNotification is true (the default) and on schedule() calls. If the exact-alarm permission is denied and any notification being scheduled has this set to true, the whole schedule() call is rejected instead of falling back to an inexact alarm. Has no effect on update(): it never enforces this, and simply falls back to inexact like a non-mandatory notification would. | false | 8.3.0 |

Schedule

Represents a schedule for a notification.

Use either at, on, or every to schedule notifications.

| Prop | Type | Description | Since | | -------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | at | Date | Schedule a notification at a specific date and time. | 1.0.0 | | repeats | boolean | Repeat delivery of this notification at the date and time specified by at. Only available for iOS and Android. | 1.0.0 | | allowWhileIdle | boolean | Allow this notification to fire while in Doze Note that these notifications can only fire once per 9 minutes, per app. | 1.0.0 | | on | ScheduleOn | Schedule a notification on particular interval(s). This is similar to scheduling cron jobs. Only available for iOS and Android. | 1.0.0 | | every | ScheduleEvery | Schedule a notification on a particular interval. | 1.0.0 | | count | number | Limit the number times a notification is delivered by the interval specified by every. | 1.0.0 |

Date

Enables basic storage and retrieval of dates and times.

| Method | Signature | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | | toString | () => string | Returns a string representation of a date. The format of the string depends on the locale. | | toDateString | () => string | Returns a date as a string value. | | toTimeString | () => string | Returns a time as a string value. | | toLocaleString | () => string | Returns a value as a string value appropriate to the host environment's current locale. | | toLocaleDateString | () => string | Returns a date as a string value appropriate to the host environment's current locale. | | toLocaleTimeString | () => string | Returns a time as a string value appropriate to the host environment's current locale. | | valueOf | () => number | Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC. | | getTime | () => number | Gets the time value in milliseconds. | | getFullYear | () => number | Gets the year, using local time. | | getUTCFullYear | () => number | Gets the year using Universal Coordinated Time (UTC). | | getMonth | () => number | Gets the month, using local time. | | getUTCMonth | () => number | Gets the month of a Date object using Universal Coordinated Time (UTC). | | getDate | () => number | Gets the day-of-the-month, using local time. | | getUTCDate | () => number | Gets the day-of-the-month, using Universal Coordinated Time (UTC). | | getDay | () => number | Gets the day of the week, using local time. | | getUTCDay | () => number | Gets the day of the week using Universal Coordinated Time (UTC). | | getHours | () => number | Gets the hours in a date, using local time. | | getUTCHours | () => number | Gets the hours value in a Date object using Universal Coordinated Time (UTC). | | getMinutes | () => number | Gets the minutes of a Date object, using local time. | | getUTCMinutes | () => number | Gets the minutes of a Date object using Universal Coordinated Time (UTC). | | getSeconds | () => number | Gets the seconds of a Date object, using local time. | | getUTCSeconds | () => number | Gets the seconds of a Date object using Universal Coordinated Time (UTC). | | getMilliseconds | () => number | Gets the milliseconds of a Date, using local time. | | getUTCMilliseconds | () => number | Gets the milliseconds of a Date object using Universal Coordinated Time (UTC). | | getTimezoneOffset | () => number | Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC). | | setTime | (time: number) => number | Sets the date and time value in the Date object. | | setMilliseconds | (ms: number) => number | Sets the milliseconds value in the Date object using local time. | | setUTCMilliseconds | (ms: number) => number | Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC). | | setSeconds | (sec: number, ms?: number | undefined) => number | Sets the seconds value in the Date object using local time. | | setUTCSeconds | (sec: number, ms?: number | undefined) => number | Sets the seconds value in the Date object using Universal Coordinated Time (UTC). | | setMinutes | (min: number, sec?: number | undefined, ms?: number | undefined) => number | Sets the minutes value in the Date object using local time. | | setUTCMinutes | (min: number, sec?: number | undefined, ms?: number | undefined) => number | Sets the minutes value in the Date object using Universal Coordinated Time (UTC). | | setHours | (hours: number, min?: number | undefined, sec?: number | undefined, ms?: number | undefined) => number | Sets the hour value in the Date object using local time. | | setUTCHours | (hours: number, min?: number | undefined, sec?: number | undefined, ms?: number | undefined) => number | Sets the hours value in the Date object using Universal Coordinated Time (UTC). | | setDate | (date: number) => number | Sets the numeric day-of-the-month value of the Date object using local time. | | setUTCDate | (date: number) => number | Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC). | | setMonth | (month: number, date?: number | undefined) => number | Sets the month value in the Date object using local time. | | setUTCMonth | (month: number, date?: number | undefined) => number | Sets the month value in the Date object using Universal Coordinated Time (UTC). | | setFullYear | (year: number, month?: number | undefined, date?: number | undefined) => number | Sets the year of the Date object using local time. | | setUTCFullYear | (year: number, month?: number | undefined, date?: number | undefined) => number | Sets the year value in the Date object using Universal Coordinated Time (UTC). | | toUTCString | () => string | Returns a date converted to a string using Universal Coordinated Time (UTC). | | toISOString | () => string | Returns a date as a string value in ISO format. | | toJSON | (key?: any) => string | Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization. |

ScheduleOn

| Prop | Type | | ------------- | ------------------------------------------- | | year | number | | month | number | | day | number | | weekday | Weekday | | hour | number | | minute | number | | second | number |

Attachment

Represents a notification attachment.

| Prop | Type | Description | Since | | ------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----- | | id | string | The attachment identifier. | 1.0.0 | | url | string | The URL to the attachment. Use the res scheme to reference web assets, e.g. res:///assets/img/icon.png. Also accepts file URLs. | 1.0.0 | | options | AttachmentOptions | Attachment options. | 1.0.0 |

AttachmentOptions

| Prop | Type | Description