Firebase Cloud Messaging module.
Exceptions
QuotaExceededErrorexceptionfirebase_admin.messaging. QuotaExceededError (message, cause=None, http_response=None) |
---|
Bases: Sending limit exceeded for the message target. |
SenderIdMismatchErrorexceptionfirebase_admin.messaging. SenderIdMismatchError (message, cause=None, http_response=None) |
---|
Bases: The authenticated sender ID is different from the sender ID for the registration token. |
ThirdPartyAuthErrorexceptionfirebase_admin.messaging. ThirdPartyAuthError (message, cause=None, http_response=None) |
---|
Bases: APNs certificate or web push auth key was invalid or missing. |
UnregisteredErrorexceptionfirebase_admin.messaging. UnregisteredError (message, cause=None, http_response=None) |
---|
Bases: App instance was unregistered from FCM. This usually means that the token used is no longer valid and a new one must be used. |
Classes
AndroidConfigclassfirebase_admin.messaging. AndroidConfig (collapse_key=None, priority=None, ttl=None, restricted_package_name=None, data=None, notification=None, fcm_options=None) | ||
---|---|---|
Bases: Android-specific options that can be included in a message.
|
AndroidFCMOptionsclassfirebase_admin.messaging. AndroidFCMOptions (analytics_label=None) | ||
---|---|---|
Bases: Options for features provided by the FCM SDK for Android.
|
AndroidNotificationclassfirebase_admin.messaging. AndroidNotification (title=None, body=None, icon=None, color=None, sound=None, tag=None, click_action=None, body_loc_key=None, body_loc_args=None, title_loc_key=None, title_loc_args=None, channel_id=None, image=None, ticker=None, sticky=None, event_timestamp=None, local_only=None, priority=None, vibrate_timings_millis=None, default_vibrate_timings=None, default_sound=None, light_settings=None, default_light_settings=None, visibility=None, notification_count=None) | ||
---|---|---|
Bases: Android-specific notification parameters.
|
APNSConfigclassfirebase_admin.messaging. APNSConfig (headers=None, payload=None, fcm_options=None) | ||
---|---|---|
Bases: APNS-specific options that can be included in a message. Refer to APNS Documentation for more information.
|
APNSFCMOptionsclassfirebase_admin.messaging. APNSFCMOptions (analytics_label=None, image=None) | ||
---|---|---|
Bases: Options for features provided by the FCM SDK for iOS.
|
APNSPayloadclassfirebase_admin.messaging. APNSPayload (aps, **kwargs) | ||
---|---|---|
Bases: Payload of an APNS message.
|
Apsclassfirebase_admin.messaging. Aps (alert=None, badge=None, sound=None, content_available=None, category=None, thread_id=None, mutable_content=None, custom_data=None) | ||
---|---|---|
Bases: Aps dictionary to be included in an APNS payload.
|
ApsAlertclassfirebase_admin.messaging. ApsAlert (title=None, subtitle=None, body=None, loc_key=None, loc_args=None, title_loc_key=None, title_loc_args=None, action_loc_key=None, launch_image=None, custom_data=None) | ||
---|---|---|
Bases: An alert that can be included in
|
BatchResponseclassfirebase_admin.messaging. BatchResponse (responses) |
---|
Bases: The response received from a batch request to the FCM API.
|
CriticalSoundclassfirebase_admin.messaging. CriticalSound (name, critical=None, volume=None) |
---|
Bases: Critical alert sound configuration that can be included in |