Aps interface

Represents the aps dictionary that is part of APNs messages.

Signature:

export interface Aps

Properties

Property Type Description
alert string | ApsAlert Alert to be included in the message. This may be a string or an object of type admin.messaging.ApsAlert.
badge number Badge to be displayed with the message. Set to 0 to remove the badge. When not specified, the badge will remain unchanged.
category string Type of the notification.
contentAvailable boolean Specifies whether to configure a background update notification.
mutableContent boolean Specifies whether to set the mutable-content property on the message so the clients can modify the notification via app extensions.
sound string | CriticalSound Sound to be played with the message.
threadId string An app-specific identifier for grouping notifications.

Aps.alert

Alert to be included in the message. This may be a string or an object of type admin.messaging.ApsAlert.

Signature:

alert?: string | ApsAlert;

Aps.badge

Badge to be displayed with the message. Set to 0 to remove the badge. When not specified, the badge will remain unchanged.

Signature:

badge?: number;

Aps.category

Type of the notification.

Signature:

category?: string;

Aps.contentAvailable

Specifies whether to configure a background update notification.

Signature:

contentAvailable?: boolean;

Aps.mutableContent

Specifies whether to set the mutable-content property on the message so the clients can modify the notification via app extensions.

Signature:

mutableContent?: boolean;

Aps.sound

Sound to be played with the message.

Signature:

sound?: string | CriticalSound;

Aps.threadId

An app-specific identifier for grouping notifications.

Signature:

threadId?: string;