Stay organized with collections
Save and categorize content based on your preferences.
FirebaseAdmin.Messaging.Aps
Represents the aps dictionary that is part of every APNs message.
Summary
Properties
|
Alert
|
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
|
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.
|
Properties
Alert
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.
AlertString
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.
Badge
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.
Category
string Category
Gets or sets the type of the notification.
ContentAvailable
bool ContentAvailable
Gets or sets a value indicating whether to configure a background update notification.
CriticalSound
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.
CustomData
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.
MutableContent
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.
Sound
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.
ThreadId
string ThreadId
Gets or sets the app-specific identifier for grouping notifications.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-03-24 UTC.
[null,null,["Last updated 2022-03-24 UTC."],[],[],null,["# FirebaseAdmin.Messaging.Aps Class Reference\n\nFirebaseAdmin.Messaging.Aps\n===========================\n\nRepresents the [aps dictionary](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html) that is part of every APNs message.\n\nSummary\n-------\n\n| ### Properties ||\n|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Alert](#class_firebase_admin_1_1_messaging_1_1_aps_1a38f3f8bb7aba2acd0e6a851291ffed35) | [ApsAlert](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps-alert#class_firebase_admin_1_1_messaging_1_1_aps_alert) Gets or sets an advanced alert configuration to be included in the message. |\n| [AlertString](#class_firebase_admin_1_1_messaging_1_1_aps_1abf34aec27e8b3d26a6a5e35c48392f60) | `string` Gets or sets the alert text to be included in the message. |\n| [Badge](#class_firebase_admin_1_1_messaging_1_1_aps_1a17b5dd427b793f6ccd6d49e9ea57f84a) | `int` Gets or sets the badge to be displayed with the message. |\n| [Category](#class_firebase_admin_1_1_messaging_1_1_aps_1a255d0babff997239a4c6db38096b8e62) | `string` Gets or sets the type of the notification. |\n| [ContentAvailable](#class_firebase_admin_1_1_messaging_1_1_aps_1ad8bfba3091e2ca4b2cf9e69a31c31bf8) | `bool` Gets or sets a value indicating whether to configure a background update notification. |\n| [CriticalSound](#class_firebase_admin_1_1_messaging_1_1_aps_1aa14e87b958864c964df08e3185f71a79) | [CriticalSound](/docs/reference/admin/dotnet/class/firebase-admin/messaging/critical-sound#class_firebase_admin_1_1_messaging_1_1_critical_sound) Gets or sets the critical alert sound to be played with the message. |\n| [CustomData](#class_firebase_admin_1_1_messaging_1_1_aps_1a59098a4d657d5fc5d596bcb9e2c2a774) | `IDictionary\u003c string, object \u003e` Gets or sets a collection of arbitrary key-value data to be included in the `aps` dictionary. |\n| [MutableContent](#class_firebase_admin_1_1_messaging_1_1_aps_1a825e6a6648761ce814e9e8fa72895ae7) | `bool` Gets or sets a value indicating whether to include the `mutable-content` property in the message. |\n| [Sound](#class_firebase_admin_1_1_messaging_1_1_aps_1abf62013b8f49cbe6494e1c1a162d427d) | `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. |\n| [ThreadId](#class_firebase_admin_1_1_messaging_1_1_aps_1a058f750de0d7b47a1fc243e1211c67f5) | `string` Gets or sets the app-specific identifier for grouping notifications. |\n\nProperties\n----------\n\n### Alert\n\n```text\nApsAlert Alert\n``` \nGets or sets an advanced alert configuration to be included in the message.\n\nIt is an error to set both [Alert](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps#class_firebase_admin_1_1_messaging_1_1_aps_1a38f3f8bb7aba2acd0e6a851291ffed35) and [AlertString](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps#class_firebase_admin_1_1_messaging_1_1_aps_1abf34aec27e8b3d26a6a5e35c48392f60) properties together. \n\n### AlertString\n\n```text\nstring AlertString\n``` \nGets or sets the alert text to be included in the message.\n\nTo specify a more advanced alert configuration, use the [Alert](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps#class_firebase_admin_1_1_messaging_1_1_aps_1a38f3f8bb7aba2acd0e6a851291ffed35) property instead. It is an error to set both [Alert](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps#class_firebase_admin_1_1_messaging_1_1_aps_1a38f3f8bb7aba2acd0e6a851291ffed35) and [AlertString](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps#class_firebase_admin_1_1_messaging_1_1_aps_1abf34aec27e8b3d26a6a5e35c48392f60) properties together. \n\n### Badge\n\n```text\nint Badge\n``` \nGets or sets the badge to be displayed with the message.\n\nSet to 0 to remove the badge. When not specified, the badge will remain unchanged. \n\n### Category\n\n```text\nstring Category\n``` \nGets or sets the type of the notification. \n\n### ContentAvailable\n\n```text\nbool ContentAvailable\n``` \nGets or sets a value indicating whether to configure a background update notification. \n\n### CriticalSound\n\n```text\nCriticalSound CriticalSound\n``` \nGets or sets the critical alert sound to be played with the message.\n\nIt is an error to set both [Sound](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps#class_firebase_admin_1_1_messaging_1_1_aps_1abf62013b8f49cbe6494e1c1a162d427d) and [CriticalSound](/docs/reference/admin/dotnet/class/firebase-admin/messaging/critical-sound#class_firebase_admin_1_1_messaging_1_1_critical_sound) properties together. \n\n### CustomData\n\n```text\nIDictionary\u003c string, object \u003e CustomData\n``` \nGets or sets a collection of arbitrary key-value data to be included in the `aps` dictionary.\n\nThis is exposed as an IDictionary{TKey, TValue} to support correct deserialization of custom properties. \n\n### MutableContent\n\n```text\nbool MutableContent\n``` \nGets or sets a value indicating whether to include the `mutable-content` property in the message.\n\nWhen set, this property allows clients to modify the notification via app extensions. \n\n### Sound\n\n```text\nstring Sound\n``` \nGets 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.\n\nSpecify the string `default` to play the system sound. It is an error to set both [Sound](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps#class_firebase_admin_1_1_messaging_1_1_aps_1abf62013b8f49cbe6494e1c1a162d427d) and [CriticalSound](/docs/reference/admin/dotnet/class/firebase-admin/messaging/critical-sound#class_firebase_admin_1_1_messaging_1_1_critical_sound) properties together. \n\n### ThreadId\n\n```text\nstring ThreadId\n``` \nGets or sets the app-specific identifier for grouping notifications."]]
