feat(fcm): Add bandwidthConstrainedOk and restrictedSatelliteOk (#2994)

lahirumaramba · google-labs-jules[bot] · web-flow · commit 7fbad72eb4a4 · 2026-03-23T16:48:43.000-04:00
* feat(messaging): Add bandwidthConstrainedOk and restrictedSatelliteOk to AndroidConfig

Adds two new optional boolean properties, `bandwidthConstrainedOk` and `restrictedSatelliteOk`, to the `AndroidConfig` type in the messaging API.

This change includes:
- Updating the `AndroidConfig` interface in `src/messaging/messaging-api.ts`.
- Adding the corresponding property mappings in `src/messaging/messaging-internal.ts`.
- Updating unit tests in `test/unit/messaging/messaging.spec.ts` to cover the new properties.

* feat(messaging): Add bandwidthConstrainedOk and restrictedSatelliteOk to AndroidConfig

Adds two new optional boolean properties, `bandwidthConstrainedOk` and `restrictedSatelliteOk`, to the `AndroidConfig` type in the messaging API.

This change includes:
- Updating the `AndroidConfig` interface in `src/messaging/messaging-api.ts`.
- Adding the corresponding property mappings in `src/messaging/messaging-internal.ts`.
- Updating unit tests in `test/unit/messaging/messaging.spec.ts` to cover the new properties.
- Updating the public API documentation.

* fix docstrings

---------

Co-authored-by: google-labs-jules[bot] &lt;161369871+google-labs-jules[bot]@users.noreply.github.com&gt;
diff --git a/etc/firebase-admin.messaging.api.md b/etc/firebase-admin.messaging.api.md
@@ -8,6 +8,7 @@ import { Agent } from 'http';
 
 // @public
 export interface AndroidConfig {
+    bandwidthConstrainedOk?: boolean;
     collapseKey?: string;
     data?: {
         [key: string]: string;
@@ -17,6 +18,7 @@ export interface AndroidConfig {
     notification?: AndroidNotification;
     priority?: ('high' | 'normal');
     restrictedPackageName?: string;
+    restrictedSatelliteOk?: boolean;
     ttl?: number;
 }
 
diff --git a/src/messaging/messaging-api.ts b/src/messaging/messaging-api.ts
@@ -428,6 +428,18 @@ export interface AndroidConfig {
   * the app while the device is in direct boot mode.
   */
   directBootOk?: boolean;
+
+  /**
+   * A boolean indicating whether messages will be allowed to be delivered to  
+   * the app while the device is on a bandwidth constrained network.
+   */
+  bandwidthConstrainedOk?: boolean;
+
+  /**
+   * A boolean indicating whether messages will be allowed to be delivered to  
+   * the app while the device is on a restricted satellite network.
+   */
+  restrictedSatelliteOk?: boolean;
 }
 
 /**
diff --git a/src/messaging/messaging-internal.ts b/src/messaging/messaging-internal.ts
@@ -422,6 +422,8 @@ function validateAndroidConfig(config: AndroidConfig | undefined): void {
     collapseKey: 'collapse_key',
     restrictedPackageName: 'restricted_package_name',
     directBootOk: 'direct_boot_ok',
+    bandwidthConstrainedOk: 'bandwidth_constrained_ok',
+    restrictedSatelliteOk: 'restricted_satellite_ok',
   };
   renameProperties(config, propertyMappings);
 }
diff --git a/test/unit/messaging/messaging.spec.ts b/test/unit/messaging/messaging.spec.ts
@@ -1899,6 +1899,8 @@ describe('Messaging', () => {
             collapseKey: 'test.key',
             restrictedPackageName: 'test.package',
             directBootOk: true,
+            bandwidthConstrainedOk: true,
+            restrictedSatelliteOk: true,
             notification: {
               clickAction: 'test.click.action',
               titleLocKey: 'title.loc.key',
@@ -1927,6 +1929,8 @@ describe('Messaging', () => {
             collapse_key: 'test.key',
             restricted_package_name: 'test.package',
             direct_boot_ok: true,
+            bandwidth_constrained_ok: true,
+            restricted_satellite_ok: true,
             notification: {
               click_action: 'test.click.action',
               title_loc_key: 'title.loc.key',
@@ -1983,6 +1987,8 @@ describe('Messaging', () => {
             collapseKey: 'test.key',
             restrictedPackageName: 'test.package',
             directBootOk: true,
+            bandwidthConstrainedOk: true,
+            restrictedSatelliteOk: true,
             ttl: 5,
             data: {
               k1: 'v1',
@@ -2031,6 +2037,8 @@ describe('Messaging', () => {
             collapse_key: 'test.key',
             restricted_package_name: 'test.package',
             direct_boot_ok: true,
+            bandwidth_constrained_ok: true,
+            restricted_satellite_ok: true,
             ttl: '0.005000000s', // 5 ms = 5,000,000 ns
             data: {
               k1: 'v1',

Original file line number	Diff line number	Diff line change
`@@ -422,6 +422,8 @@ function validateAndroidConfig(config: AndroidConfig \| undefined): void {`
`422`	`422`	`collapseKey: 'collapse_key',`
`423`	`423`	`restrictedPackageName: 'restricted_package_name',`
`424`	`424`	`directBootOk: 'direct_boot_ok',`
	`425`	`+ bandwidthConstrainedOk: 'bandwidth_constrained_ok',`
	`426`	`+ restrictedSatelliteOk: 'restricted_satellite_ok',`
`425`	`427`	`};`
`426`	`428`	`renameProperties(config, propertyMappings);`
`427`	`429`	`}`