FirebaseAdmin.Messaging

Summary

Enumerations
`Direction{ Auto, LeftToRight, RightToLeft }`	enum Different directions a notification can be displayed in.
`MessagingErrorCode{ ThirdPartyAuthError, InvalidArgument, Internal, QuotaExceeded, SenderIdMismatch, Unavailable, Unregistered }`	enum Error codes that can be raised by the Cloud Messaging APIs.
`NotificationPriority{ MIN, LOW, DEFAULT, HIGH, MAX }`	enum Priority levels that can be set on an AndroidNotification.
`NotificationProxy{ Allow, Deny, IfPriorityLowered }`	enum Proxy behavior that can be set on an AndroidNotification.
`NotificationVisibility{ PRIVATE, PUBLIC, SECRET }`	enum Visibility levels that can be set on an AndroidNotification.
`Priority{ High, Normal }`	enum Priority levels that can be set on an AndroidConfig.

Classes
FirebaseAdmin.Messaging.Action	Represents an action available to users when the notification is presented.
FirebaseAdmin.Messaging.AndroidConfig	Represents the Android-specific options that can be included in a Message.
FirebaseAdmin.Messaging.AndroidFcmOptions	Represents Android FCM options.
FirebaseAdmin.Messaging.AndroidNotification	Represents the Android-specific notification options that can be included in a Message.
FirebaseAdmin.Messaging.ApnsConfig	Represents the APNS-specific options that can be included in a Message.
FirebaseAdmin.Messaging.ApnsFcmOptions	Represents Apple Push Notification Service FCM options.
FirebaseAdmin.Messaging.Aps	Represents the aps dictionary that is part of every APNs message.
FirebaseAdmin.Messaging.ApsAlert	Represents the alert property that can be included in the `aps` dictionary of an APNs payload.
FirebaseAdmin.Messaging.BatchResponse	Response from an operation that sends FCM messages to multiple recipients.
FirebaseAdmin.Messaging.CriticalSound	The sound configuration for APNs critical alerts.
FirebaseAdmin.Messaging.ErrorInfo	A topic management error.
FirebaseAdmin.Messaging.FcmOptions	Represents FCM options.
FirebaseAdmin.Messaging.FirebaseMessaging	This is the entry point to all server-side Firebase Cloud Messaging (FCM) operations.
FirebaseAdmin.Messaging.FirebaseMessagingException	Exception type raised by Firebase Cloud Messaging APIs.
FirebaseAdmin.Messaging.LightSettings	Represents light settings in an Android Notification.
FirebaseAdmin.Messaging.Message	Represents a message that can be sent via Firebase Cloud Messaging (FCM).
FirebaseAdmin.Messaging.MulticastMessage	Represents a message that can be sent to multiple devices via Firebase Cloud Messaging (FCM).
FirebaseAdmin.Messaging.Notification	Represents the notification parameters that can be included in a Message.
FirebaseAdmin.Messaging.SendResponse	The result of an individual send operation that was executed as part of a batch.
FirebaseAdmin.Messaging.TopicManagementResponse	The response produced by FCM topic management operations.
FirebaseAdmin.Messaging.WebpushConfig	Represents the Webpush protocol options that can be included in a Message.
FirebaseAdmin.Messaging.WebpushFcmOptions	Represents the Webpush-specific notification options that can be included in a Message.
FirebaseAdmin.Messaging.WebpushNotification	Represents the Webpush-specific notification options that can be included in a Message.

Namespaces
FirebaseAdmin.Messaging.Util

Enumerations

Direction

 Direction

Different directions a notification can be displayed in.

Properties
`Auto`	Direction automatically determined.
`LeftToRight`	Left to right.
`RightToLeft`	Right to left.

MessagingErrorCode

 MessagingErrorCode

Error codes that can be raised by the Cloud Messaging APIs.

Properties
`Internal`	Internal server error.
`InvalidArgument`	One or more argument specified in the request was invalid.
`QuotaExceeded`	Sending limit exceeded for the message target.
`SenderIdMismatch`	The authenticated sender ID is different from the sender ID for the registration token.
`ThirdPartyAuthError`	APNs certificate or web push auth key was invalid or missing.
`Unavailable`	Cloud Messaging service is temporarily unavailable.
`Unregistered`	App instance was unregistered from FCM. This usually means that the token used is no longer valid and a new one must be used.

NotificationPriority

 NotificationPriority

Priority levels that can be set on an AndroidNotification.

Properties
`DEFAULT`	Default priority notification.
`HIGH`	High priority notification.
`LOW`	Low priority notification.
`MAX`	Maximum priority notification.
`MIN`	Minimum priority notification.

NotificationProxy

 NotificationProxy

Proxy behavior that can be set on an AndroidNotification.

Properties
`Allow`	Try to proxy this notification.
`Deny`	Do not proxy this notification.
`IfPriorityLowered`	Only try to proxy this notification if its `AndroidMessagePriority` was lowered from HIGH to NORMAL on the device.

NotificationVisibility

 NotificationVisibility

Visibility levels that can be set on an AndroidNotification.

Properties
`PRIVATE`	Private visibility.
`PUBLIC`	Public visibility.
`SECRET`	Secret visibility.

Priority

 Priority

Priority levels that can be set on an AndroidConfig.

Properties
`High`	High priority message.
`Normal`	Normal priority message.

FirebaseAdmin.Messaging

Summary

Enumerations

Classes

Namespaces

Enumerations

Direction

MessagingErrorCode

NotificationPriority

NotificationProxy

NotificationVisibility

Priority