Skip to content

feat(fcm): Add support for AndroidConfigV2 #968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanedey wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat(fcm): Add support for AndroidConfigV2 #968

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3f4c8e1
feat(fcm): Add support for AndroidConfigV2
jonathanedey Jul 20, 2026
322c1d5
chore(fcm): Deprecate V1 configuration classes and refactor V2 to dat…
jonathanedey Jul 20, 2026
ff207ca
fix(fcm): Support datetime.timedelta in V2 vibrate_timings_millis val…
jonathanedey Jul 20, 2026
287bbd0
fix(fcm): Add boolean validation and fix vibrate timings check in And…
jonathanedey Jul 29, 2026
08cc892
chore(fcm): Add integration tests for AndroidConfigV2
jonathanedey Sep 16, 2026
51543a3
Merge branch 'main' into je-fcm-v2
jonathanedey Sep 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore(fcm): Deprecate V1 configuration classes and refactor V2 to dat… 
…aclasses
  • Loading branch information
@jonathanedey
jonathanedey committed Jul 20, 2026
commit 322c1d5fdc1d482de6bb5da3dd36c56a6dfa7ea7
153 changes: 61 additions & 92 deletions firebase_admin/_messaging_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@

"""Types and utilities used by the messaging (FCM) module."""
from __future__ import annotations
from dataclasses import dataclass
import datetime
from typing import Dict, List, Optional, Union
import warnings

from firebase_admin import exceptions

Expand All @@ -38,6 +40,8 @@ def __init__(self, title=None, body=None, image=None):
class AndroidConfig:
"""Android-specific options that can be included in a message.

AndroidConfig is deprecated. Use AndroidConfigV2 instead.

Args:
collapse_key: Collapse key string for the message (optional). This is an identifier for a
group of messages that can be collapsed, so that only the last message is sent when
Expand Down Expand Up @@ -73,6 +77,11 @@ def __init__(
bandwidth_constrained_ok: Optional[bool] = None,
restricted_satellite_ok: Optional[bool] = None
):
warnings.warn(
'AndroidConfig is deprecated. Use AndroidConfigV2 instead.',
DeprecationWarning,
stacklevel=2
)
self.collapse_key = collapse_key
self.priority = priority
self.ttl = ttl
Expand All @@ -85,6 +94,7 @@ def __init__(
self.restricted_satellite_ok = restricted_satellite_ok


@dataclass
class AndroidConfigV2:
"""Android-specific options that can be included in a message (V2).

Expand All @@ -111,35 +121,23 @@ class AndroidConfigV2:
restricted_satellite_ok: A boolean indicating whether messages will be allowed to be
delivered to the app while the device is on a restricted satellite network (optional).
"""

def __init__(
self,
collapse_key: Optional[str] = None,
ttl: Optional[Union[int, float, datetime.timedelta]] = None,
restricted_package_name: Optional[str] = None,
data: Optional[Dict[str, str]] = None,
remote_notification: Optional[AndroidRemoteNotification] = None,
background_sync: Optional[AndroidBackgroundSyncMessage] = None,
fcm_options: Optional[AndroidFCMOptions] = None,
direct_boot_ok: Optional[bool] = None,
bandwidth_constrained_ok: Optional[bool] = None,
restricted_satellite_ok: Optional[bool] = None
):
self.collapse_key = collapse_key
self.ttl = ttl
self.restricted_package_name = restricted_package_name
self.data = data
self.remote_notification = remote_notification
self.background_sync = background_sync
self.fcm_options = fcm_options
self.direct_boot_ok = direct_boot_ok
self.bandwidth_constrained_ok = bandwidth_constrained_ok
self.restricted_satellite_ok = restricted_satellite_ok
collapse_key: Optional[str] = None
ttl: Optional[Union[int, float, datetime.timedelta]] = None
restricted_package_name: Optional[str] = None
data: Optional[Dict[str, str]] = None
remote_notification: Optional[AndroidRemoteNotification] = None
background_sync: Optional[AndroidBackgroundSyncMessage] = None
fcm_options: Optional[AndroidFCMOptions] = None
direct_boot_ok: Optional[bool] = None
bandwidth_constrained_ok: Optional[bool] = None
restricted_satellite_ok: Optional[bool] = None


class AndroidNotification:
"""Android-specific notification parameters.

AndroidNotification is deprecated. Use AndroidNotificationV2 instead.

Args:
title: Title of the notification (optional). If specified, overrides the title set via
``messaging.Notification``.
Expand Down Expand Up @@ -232,6 +230,11 @@ def __init__(self, title=None, body=None, icon=None, color=None, sound=None, tag
default_vibrate_timings=None, default_sound=None, light_settings=None,
default_light_settings=None, visibility=None, notification_count=None,
proxy=None):
warnings.warn(
'AndroidNotification is deprecated. Use AndroidNotificationV2 instead.',
DeprecationWarning,
stacklevel=2
)
self.title = title
self.body = body
self.icon = icon
Expand Down Expand Up @@ -260,6 +263,7 @@ def __init__(self, title=None, body=None, icon=None, color=None, sound=None, tag
self.proxy = proxy


@dataclass
class AndroidNotificationV2:
"""Android-specific notification options (V2).

Expand Down Expand Up @@ -345,64 +349,35 @@ class AndroidNotificationV2:
unspecified, systems that support badging use the default, which is to increment a
number displayed on the long-press menu each time a new notification arrives.
"""

def __init__(
self,
title: Optional[str] = None,
body: Optional[str] = None,
icon: Optional[str] = None,
color: Optional[str] = None,
sound: Optional[str] = None,
tag: Optional[str] = None,
id: Optional[int] = None, # pylint: disable=redefined-builtin,invalid-name
click_action: Optional[str] = None,
body_loc_key: Optional[str] = None,
body_loc_args: Optional[List[str]] = None,
title_loc_key: Optional[str] = None,
title_loc_args: Optional[List[str]] = None,
channel_id: Optional[str] = None,
image: Optional[str] = None,
ticker: Optional[str] = None,
sticky: Optional[bool] = None,
event_time: Optional[datetime.datetime] = None,
local_only: Optional[bool] = None,
notification_priority: Optional[str] = None,
vibrate_timings_millis: Optional[List[Union[int, float, datetime.timedelta]]] = None,
default_vibrate_timings: Optional[bool] = None,
default_sound: Optional[bool] = None,
light_settings: Optional[LightSettings] = None,
default_light_settings: Optional[bool] = None,
visibility: Optional[str] = None,
notification_count: Optional[int] = None
):
self.title = title
self.body = body
self.icon = icon
self.color = color
self.sound = sound
self.tag = tag
self.id = id # pylint: disable=invalid-name
self.click_action = click_action
self.body_loc_key = body_loc_key
self.body_loc_args = body_loc_args
self.title_loc_key = title_loc_key
self.title_loc_args = title_loc_args
self.channel_id = channel_id
self.image = image
self.ticker = ticker
self.sticky = sticky
self.event_time = event_time
self.local_only = local_only
self.notification_priority = notification_priority
self.vibrate_timings_millis = vibrate_timings_millis
self.default_vibrate_timings = default_vibrate_timings
self.default_sound = default_sound
self.light_settings = light_settings
self.default_light_settings = default_light_settings
self.visibility = visibility
self.notification_count = notification_count


title: Optional[str] = None
body: Optional[str] = None
icon: Optional[str] = None
color: Optional[str] = None
sound: Optional[str] = None
tag: Optional[str] = None
id: Optional[int] = None # pylint: disable=redefined-builtin,invalid-name
click_action: Optional[str] = None
body_loc_key: Optional[str] = None
body_loc_args: Optional[List[str]] = None
title_loc_key: Optional[str] = None
title_loc_args: Optional[List[str]] = None
channel_id: Optional[str] = None
image: Optional[str] = None
ticker: Optional[str] = None
sticky: Optional[bool] = None
event_time: Optional[datetime.datetime] = None
local_only: Optional[bool] = None
notification_priority: Optional[str] = None
vibrate_timings_millis: Optional[List[Union[int, float, datetime.timedelta]]] = None
default_vibrate_timings: Optional[bool] = None
default_sound: Optional[bool] = None
light_settings: Optional[LightSettings] = None
default_light_settings: Optional[bool] = None
visibility: Optional[str] = None
notification_count: Optional[int] = None


@dataclass
class AndroidRemoteNotification:
"""Android remote notification options.

Expand All @@ -413,18 +388,12 @@ class AndroidRemoteNotification:
use_as_v1_data_message: A boolean indicating whether to use as a V1 data message
fallback (optional).
"""

def __init__(
self,
notification: AndroidNotificationV2,
mutable_content: Optional[bool] = None,
use_as_v1_data_message: Optional[bool] = None
):
self.notification = notification
self.mutable_content = mutable_content
self.use_as_v1_data_message = use_as_v1_data_message
notification: AndroidNotificationV2
mutable_content: Optional[bool] = None
use_as_v1_data_message: Optional[bool] = None


@dataclass
class AndroidBackgroundSyncMessage:
"""Android background sync message options."""

Expand Down
Loading