Titanium SDK

# NotificationParams

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

Availability
1.7
9.2.0
Extends
Object

NOTE

This is an abstract type. Any object of this structure can be used where this type is used.

# Properties

# alertAction

Availability
1.7
9.2.0
alertAction :String

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

# alertBody

Availability
1.7
9.2.0
alertBody :String

Alert message to display.

# alertLaunchImage

Availability
1.7
9.2.0
alertLaunchImage :String

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

# alertSubtitle

Availability
7.3.0
9.2.0
alertSubtitle :String

Alert subtitle to display.

# alertTitle

Availability
7.3.0
9.2.0
alertTitle :String

Alert title to display.

# attachments

Availability
7.3.0
9.2.0
attachments :Array<UserNotificationAttachment>

Notification attachments to display.

# badge

Availability
1.7
9.2.0
badge :Number

Application badge value.

# category

Availability
1.7
9.2.0
category :String

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

# date

Availability
1.7
9.2.0
date :Date

Date and time for the notification to occur.

# identifier

Availability
7.3.0
9.2.0
identifier :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

Availability
7.3.0
9.2.0
region :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

Availability
1.7
9.2.0
repeat :String

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

# sound

Availability
1.7
9.2.0
sound :String

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

# summaryArgument

Availability
7.4.0
9.2.0
summaryArgument :String

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

# summaryArgumentCount

Availability
7.4.0
9.2.0
summaryArgumentCount :String

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

# timezone

Availability
1.7
9.2.0
timezone :String

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

# userInfo

Availability
1.7
9.2.0
userInfo :Dictionary

Data to pass to the application with the notification event.

Contents