# Titanium.App.iOS.UserNotificationCenter

The top-level App iOS Notification Center module. It is used to control scheduled notifications and receive details about the system-wide notification settings.

Availability

7.3.0

9.2.0

Extends

Titanium.Module

# Properties

# apiName READONLY

Availability

7.3.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.

# Methods

# getDeliveredNotifications

Availability

7.3.0

9.2.0

getDeliveredNotifications(callback) → void

Fetches the delivered notifications asynchronously.

Parameters

Name	Type	Description
`callback`	Callback<UserNotificationCallbackResponse>	The function that is being called after the notifications have been fetched.

Returns

Type: void

# getPendingNotifications

Availability

7.3.0

9.2.0

getPendingNotifications(callback) → void

Fetches the pending notifications asynchronously.

Parameters

Name	Type	Description
`callback`	Callback<UserNotificationCallbackResponse>	The function that is being called after the notifications have been fetched.

Returns

Type: void

# removeDeliveredNotifications

Availability

7.3.0

9.2.0

removeDeliveredNotifications(notifications) → void

Removes the specified delivered notifications from the notification-center. If no notifications are specified, all delivered notifications will be removed.

Delivered notifications can be obtained via a call to the getDeliveredNotifications method.

Parameters

Name	Type	Description
`notifications`	Array<UserNotificationDictionary>	The delivered notification to remove. If none specified, all pending notifications will be removed.

Returns

Type: void

# removePendingNotifications

Availability

7.3.0

9.2.0

removePendingNotifications(notifications) → void

Removes the specified pending notifications to prevent them from being triggered. If no notifications are specified, all pending notifications will be removed.

Pending notifications can be obtained via a call to the getPendingNotifications method.

Parameters

Name	Type	Description
`notifications`	Array<UserNotificationDictionary>	The pending notification to remove. If none specified, all pending notifications will be removed.

Returns

Type: void

# requestUserNotificationSettings

Availability

7.3.0

9.2.0

requestUserNotificationSettings(callback) → void

Notification types and user notification categories the application is registered to use.

Parameters

Name	Type	Description
`callback`	Callback<GetUserNotificationSettings>	The callback invoked when requesting user notification settings.

Returns

Type: void