Stay organized with collections
Save and categorize content based on your preferences.
FirebaseAdmin.Messaging.ApsAlert
Represents the alert property that can be included in the aps dictionary of an APNs payload.
Summary
Properties
|
ActionLocKey
|
string
Gets or sets the key of the text in the app's string resources to use to localize the action button text.
|
Body
|
string
Gets or sets the body of the alert.
|
LaunchImage
|
string
Gets or sets the launch image for the notification action.
|
LocArgs
|
IEnumerable< string >
Gets or sets the resource key strings that will be used in place of the format specifiers in LocKey. |
LocKey
|
string
Gets or sets the key of the body string in the app's string resources to use to localize the body text.
|
Subtitle
|
string
Gets or sets the subtitle of the alert.
|
SubtitleLocArgs
|
IEnumerable< string >
Gets or sets the resource key strings that will be used in place of the format specifiers in SubtitleLocKey. |
SubtitleLocKey
|
string
Gets or sets the key of the subtitle string in the app's string resources to use to localize the subtitle text.
|
Title
|
string
Gets or sets the title of the alert.
|
TitleLocArgs
|
IEnumerable< string >
Gets or sets the resource key strings that will be used in place of the format specifiers in TitleLocKey. |
TitleLocKey
|
string
Gets or sets the key of the title string in the app's string resources to use to localize the title text.
|
Properties
ActionLocKey
string ActionLocKey
Gets or sets the key of the text in the app's string resources to use to localize the action button text.
Body
string Body
Gets or sets the body of the alert.
When provided, overrides the body set via Notification.Body.
LaunchImage
string LaunchImage
Gets or sets the launch image for the notification action.
LocArgs
IEnumerable< string > LocArgs
Gets or sets the resource key strings that will be used in place of the format specifiers in LocKey.
LocKey
string LocKey
Gets or sets the key of the body string in the app's string resources to use to localize the body text.
Subtitle
string Subtitle
Gets or sets the subtitle of the alert.
SubtitleLocArgs
IEnumerable< string > SubtitleLocArgs
Gets or sets the resource key strings that will be used in place of the format specifiers in SubtitleLocKey.
SubtitleLocKey
string SubtitleLocKey
Gets or sets the key of the subtitle string in the app's string resources to use to localize the subtitle text.
Title
string Title
Gets or sets the title of the alert.
When provided, overrides the title set via Notification.Title.
TitleLocArgs
IEnumerable< string > TitleLocArgs
Gets or sets the resource key strings that will be used in place of the format specifiers in TitleLocKey.
TitleLocKey
string TitleLocKey
Gets or sets the key of the title string in the app's string resources to use to localize the title text.
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.ApsAlert Class Reference\n\nFirebaseAdmin.Messaging.ApsAlert\n================================\n\nRepresents the [alert property](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html#//apple_ref/doc/uid/TP40008194-CH17-SW5) that can be included in the `aps` dictionary of an APNs payload.\n\nSummary\n-------\n\n| ### Properties ||\n|---------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [ActionLocKey](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a01287c4e434db3dfae5c7192fae67fe9) | `string` Gets or sets the key of the text in the app's string resources to use to localize the action button text. |\n| [Body](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a84a0a79a1ca7d93c29f5b1c5330c6856) | `string` Gets or sets the body of the alert. |\n| [LaunchImage](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a56251f2f5cc2d94e6396ae8cdd939068) | `string` Gets or sets the launch image for the notification action. |\n| [LocArgs](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1ae9a258605a9efebe46fa019e2055074e) | `IEnumerable\u003c string \u003e` Gets or sets the resource key strings that will be used in place of the format specifiers in [LocKey](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps-alert#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a35cde56173dc2ee3386348bd1dc549cd). |\n| [LocKey](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a35cde56173dc2ee3386348bd1dc549cd) | `string` Gets or sets the key of the body string in the app's string resources to use to localize the body text. |\n| [Subtitle](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1ad3ed241c89718e707b022ebaad3766cc) | `string` Gets or sets the subtitle of the alert. |\n| [SubtitleLocArgs](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1adc20bc1d10c7cff72ea5c03a811d1bd2) | `IEnumerable\u003c string \u003e` Gets or sets the resource key strings that will be used in place of the format specifiers in [SubtitleLocKey](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps-alert#class_firebase_admin_1_1_messaging_1_1_aps_alert_1aab7773c01aad4789cc3dff4823d87bdd). |\n| [SubtitleLocKey](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1aab7773c01aad4789cc3dff4823d87bdd) | `string` Gets or sets the key of the subtitle string in the app's string resources to use to localize the subtitle text. |\n| [Title](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1abe833758da6cae369b76249822744ccf) | `string` Gets or sets the title of the alert. |\n| [TitleLocArgs](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a03d8d2e33a383882857092e834bb72fe) | `IEnumerable\u003c string \u003e` Gets or sets the resource key strings that will be used in place of the format specifiers in [TitleLocKey](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps-alert#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a3ec931edeab19cbba9eef0f1eed7e8ba). |\n| [TitleLocKey](#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a3ec931edeab19cbba9eef0f1eed7e8ba) | `string` Gets or sets the key of the title string in the app's string resources to use to localize the title text. |\n\nProperties\n----------\n\n### ActionLocKey\n\n```text\nstring ActionLocKey\n``` \nGets or sets the key of the text in the app's string resources to use to localize the action button text. \n\n### Body\n\n```text\nstring Body\n``` \nGets or sets the body of the alert.\n\nWhen provided, overrides the body set via [Notification.Body](/docs/reference/admin/dotnet/class/firebase-admin/messaging/notification#class_firebase_admin_1_1_messaging_1_1_notification_1ac2487f71a7b455553aed14f4276b1cd9). \n\n### LaunchImage\n\n```text\nstring LaunchImage\n``` \nGets or sets the launch image for the notification action. \n\n### LocArgs\n\n```text\nIEnumerable\u003c string \u003e LocArgs\n``` \nGets or sets the resource key strings that will be used in place of the format specifiers in [LocKey](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps-alert#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a35cde56173dc2ee3386348bd1dc549cd). \n\n### LocKey\n\n```text\nstring LocKey\n``` \nGets or sets the key of the body string in the app's string resources to use to localize the body text. \n\n### Subtitle\n\n```text\nstring Subtitle\n``` \nGets or sets the subtitle of the alert. \n\n### SubtitleLocArgs\n\n```text\nIEnumerable\u003c string \u003e SubtitleLocArgs\n``` \nGets or sets the resource key strings that will be used in place of the format specifiers in [SubtitleLocKey](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps-alert#class_firebase_admin_1_1_messaging_1_1_aps_alert_1aab7773c01aad4789cc3dff4823d87bdd). \n\n### SubtitleLocKey\n\n```text\nstring SubtitleLocKey\n``` \nGets or sets the key of the subtitle string in the app's string resources to use to localize the subtitle text. \n\n### Title\n\n```text\nstring Title\n``` \nGets or sets the title of the alert.\n\nWhen provided, overrides the title set via [Notification.Title](/docs/reference/admin/dotnet/class/firebase-admin/messaging/notification#class_firebase_admin_1_1_messaging_1_1_notification_1a47986b4044134363ad8daa6e7234871d). \n\n### TitleLocArgs\n\n```text\nIEnumerable\u003c string \u003e TitleLocArgs\n``` \nGets or sets the resource key strings that will be used in place of the format specifiers in [TitleLocKey](/docs/reference/admin/dotnet/class/firebase-admin/messaging/aps-alert#class_firebase_admin_1_1_messaging_1_1_aps_alert_1a3ec931edeab19cbba9eef0f1eed7e8ba). \n\n### TitleLocKey\n\n```text\nstring TitleLocKey\n``` \nGets or sets the key of the title string in the app's string resources to use to localize the title text."]]
