FirebaseAdmin.Messaging.Aps

Represents the aps dictionary that is part of every APNs message.

Summary

Properties
`Alert`	`ApsAlert` Gets or sets an advanced alert configuration to be included in the message.
`AlertString`	`string` Gets or sets the alert text to be included in the message.
`Badge`	`int` Gets or sets the badge to be displayed with the message.
`Category`	`string` Gets or sets the type of the notification.
`ContentAvailable`	`bool` Gets or sets a value indicating whether to configure a background update notification.
`CriticalSound`	`CriticalSound` Gets or sets the critical alert sound to be played with the message.
`CustomData`	`IDictionary< string, object >` Gets or sets a collection of arbitrary key-value data to be included in the `aps` dictionary.
`MutableContent`	`bool` Gets or sets a value indicating whether to include the `mutable-content` property in the message.
`Sound`	`string` Gets or sets the name of a sound file in your app's main bundle or in the `Library/Sounds` folder of your app's container directory.
`ThreadId`	`string` Gets or sets the app-specific identifier for grouping notifications.

ApsAlert Alert

Gets or sets an advanced alert configuration to be included in the message.

It is an error to set both Alert and AlertString properties together.

string AlertString

Gets or sets the alert text to be included in the message.

To specify a more advanced alert configuration, use the Alert property instead. It is an error to set both Alert and AlertString properties together.

int Badge

Gets or sets the badge to be displayed with the message.

Set to 0 to remove the badge. When not specified, the badge will remain unchanged.

bool ContentAvailable

Gets or sets a value indicating whether to configure a background update notification.

CriticalSound CriticalSound

Gets or sets the critical alert sound to be played with the message.

It is an error to set both Sound and CriticalSound properties together.

IDictionary< string, object > CustomData

Gets or sets a collection of arbitrary key-value data to be included in the aps dictionary.

This is exposed as an IDictionary{TKey, TValue} to support correct deserialization of custom properties.

bool MutableContent

Gets or sets a value indicating whether to include the mutable-content property in the message.

When set, this property allows clients to modify the notification via app extensions.

string Sound

Gets or sets 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. It is an error to set both Sound and CriticalSound properties together.

string ThreadId

Gets or sets the app-specific identifier for grouping notifications.