AppleApsNativeMessage interface

Package:

@azure/notification-hubs

Represents a native APNs APS message.

Extends

Record<string, any>

Properties

alert	The information for displaying an alert.
badge	The number to display in a badge on your app’s icon.
category	The notification’s type.
content-available	The background notification flag. To perform a silent background update, specify the value 1 and don’t include the alert, badge, or sound keys in your payload.
content-state	The updated or final content for a Live Activity.
dismissal-date	The UNIX timestamp that represents the date at which the system ends a Live Activity and removes it from the Dynamic Island and the Lock Screen.
events	The string that describes whether you update or end an ongoing Live Activity with the remote push notification. To update the Live Activity, use update. To end the Live Activity, use end.
filter-criteria	The criteria the system evaluates to determine if it displays the notification in the current Focus.
interruption-level	The importance and delivery timing of a notification.
mutable-content	The notification service app extension flag. If the value is 1, the system passes the notification to your notification service app extension before delivery.
relevance-score	The relevance score, a number between 0 and 1, that the system uses to sort the notifications from your app. The highest score gets featured in the notification summary.
sound	The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Specify the string “default” to play the system sound. Use this key for regular notifications. For critical alerts, use the sound dictionary instead.
stale-date	The UNIX timestamp that represents the date at which a Live Activity becomes stale, or out of date.
target-content-id	The identifier of the window brought forward.
thread-id	An app-specific identifier for grouping related notifications.
timestamp	The UNIX timestamp that marks the time when you send the remote notification that updates or ends a Live Activity.

Property Details

alert

The information for displaying an alert.

alert?: string | AppleAlert

Property Value

string | AppleAlert

badge

The number to display in a badge on your app’s icon.

badge?: number

Property Value

number

category

The notification’s type.

category?: string

Property Value

string

content-available

The background notification flag. To perform a silent background update, specify the value 1 and don’t include the alert, badge, or sound keys in your payload.

content-available?: number

Property Value

number

content-state

The updated or final content for a Live Activity.

content-state?: Record<string, any>

Property Value

Record<string, any>

dismissal-date

The UNIX timestamp that represents the date at which the system ends a Live Activity and removes it from the Dynamic Island and the Lock Screen.

dismissal-date?: number

Property Value

number

events

The string that describes whether you update or end an ongoing Live Activity with the remote push notification. To update the Live Activity, use update. To end the Live Activity, use end.

events?: string

Property Value

string

filter-criteria

The criteria the system evaluates to determine if it displays the notification in the current Focus.

filter-criteria?: string

Property Value

string

interruption-level

The importance and delivery timing of a notification.

interruption-level?: "passive" | "active" | "time-sensitive" | "critical"

Property Value

"passive" | "active" | "time-sensitive" | "critical"

mutable-content

The notification service app extension flag. If the value is 1, the system passes the notification to your notification service app extension before delivery.

mutable-content?: number

Property Value

number

relevance-score

The relevance score, a number between 0 and 1, that the system uses to sort the notifications from your app. The highest score gets featured in the notification summary.

relevance-score?: number

Property Value

number

sound

The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Specify the string “default” to play the system sound. Use this key for regular notifications. For critical alerts, use the sound dictionary instead.

sound?: string | AppleCriticalSound

Property Value

string | AppleCriticalSound

stale-date

The UNIX timestamp that represents the date at which a Live Activity becomes stale, or out of date.

stale-date?: number

Property Value

number

target-content-id

The identifier of the window brought forward.

target-content-id?: string

Property Value

string

thread-id

An app-specific identifier for grouping related notifications.

thread-id?: string

Property Value

string

timestamp

The UNIX timestamp that marks the time when you send the remote notification that updates or ends a Live Activity.

timestamp?: number

Property Value

number