Titanium SDK

# Titanium.App.iOS.UserNotificationCategory

A set of notification actions to associate with a notification.

Availability
3.4.0
9.2.0
Extends
Titanium.Proxy

# Overview

To create a notification category, use the Titanium.App.iOS.createUserNotificationCategory method.

A notification category represents a collection of Titanium.App.iOS.UserNotificationAction to associate with a specific notification. The notification category allows the application to customize the notification options based on which notification style is used. For alert dialogs, only four notification actions can be displayed, while all other notifications can only display two actions.

To use a local interactive notification, you need to register the notification category using the Titanium.App.iOS.registerUserNotificationSettings method and send a notification using the Titanium.App.iOS.scheduleLocalNotification and pass the category identifier to the category property.

# Properties

# actionsForDefaultContext CREATION ONLY

Availability
3.4.0
9.2.0
actionsForDefaultContext :Array<Titanium.App.iOS.UserNotificationAction>

Array of notification actions to associate with the group.

Note that only the first four actions can be displayed for an alert dialog and on the Apple Watch. The first two actions can be displayed for all other notifications.

# actionsForMinimalContext CREATION ONLY

Availability
3.4.0
9.2.0
actionsForMinimalContext :Array<Titanium.App.iOS.UserNotificationAction>

Array of notification actions to display for non-dialog-style notification.

If not specified, the first two actions from actionsForDefaultContent are displayed. Note: This property has been removed in iOS 10. iOS 10+ will handle the actions internally.

# apiName READONLY

Availability
3.4.0
9.2.0
apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# categorySummaryFormat CREATION ONLY

Availability
7.4.0
9.2.0
categorySummaryFormat :String

A format string for the summary description used when the system groups the category's notifications.

# hiddenPreviewsBodyPlaceholder CREATION ONLY

Availability
3.4.0
9.2.0
hiddenPreviewsBodyPlaceholder :String

The placeholder text to display when notification previews are disabled for the app.

# identifier CREATION ONLY

Availability
3.4.0
9.2.0
identifier :String

Identifier for this category.

When scheduling a notification, pass this value to the category property.

# intentIdentifiers CREATION ONLY

Availability
3.4.0
9.2.0
intentIdentifiers :Array<String>

The intents related to notifications of this category.

When a notification is delivered, the presence of an intent identifier lets the system know that the notification is potentially related to the handling of a request made through Siri.

Contents