Skip to content

Titanium.App.iOS.NotificationParams

Dictionary object of parameters used to create a notification using Titanium.App.iOS.scheduleLocalNotification.

Since: 1.7 · Platforms: iphone, ipad, macos

Properties #

alertAction#

Type: String

Alert button text ('Open', by default) or home text ('Press Home to unlock', by default)
to display.

alertBody#

Type: String

Alert message to display.

alertLaunchImage#

Type: String

Image to display instead of Default.png when launching the application.

alertSubtitle#

Type: String

Alert subtitle to display.

alertTitle#

Type: String

Alert title to display.

attachments#

Type: Array<UserNotificationAttachment>

Notification attachments to display.

badge#

Type: Number

Application badge value.

category#

Type: String

String identifier of category of actions to be displayed for an interactive notification.

date#

Type: Date

Date and time for the notification to occur.

identifier#

Type: String

The notification identifier.

This property is required in iOS 10+ and will fallback to a generated
UUID-string if not set. It is recommended to manage the identifier
yourself, but you can also get the generated UUID by accessing via
the "userInfo.id" field for parity with older iOS versions.

region#

Type: Dictionary

Region the notification will be triggered in. Allowed parameter are:

- latitude: Latitude of the location center, in decimal degrees (required).
- longitude: Longitude of the location center, in decimal degrees (required).
- triggersOnce: Whether or not the notification will only fire once (optional, default: true).

repeat#

Type: String

Interval to repeat the notification. One of weekly, daily, yearly, monthly.

sound#

Type: String

Path to the sound file to play when notification occurs, relative to the Resources folder.

summaryArgument#

Type: String

The string the notification adds to the category's summary format string.

summaryArgumentCount#

Type: String

The number of items the notification adds to the category's summary format string.

timezone#

Type: String

Timezone of the date configured for the notification. If not set, the system timezone is used.

userInfo#

Type: Dictionary

Data to pass to the application with the notification event.

Titanium SDK Documentation