Skip to content

feat(fcm): Add bandwidthConstrainedOk and restrictedSatelliteOk#2994

Open
lahirumaramba wants to merge 2 commits intomainfrom
feat-android-config-properties
Open

feat(fcm): Add bandwidthConstrainedOk and restrictedSatelliteOk#2994
lahirumaramba wants to merge 2 commits intomainfrom
feat-android-config-properties

Conversation

@lahirumaramba
Copy link
Member

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.

… 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.
@lahirumaramba lahirumaramba added the release:stage Stage a release candidate label Oct 23, 2025
… 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.
Copy link
Collaborator

@jonathanedey jonathanedey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with one nit on doc string.

Comment on lines +431 to +442

/**
* A boolean indicating whether the message is allowed to be delivered in
* a low-bandwidth environment.
*/
bandwidthConstrainedOk?: boolean;

/**
* A boolean indicating whether the message is allowed to be delivered
* via satellite.
*/
restrictedSatelliteOk?: boolean;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to have the docs here match the other SDKs as well. But I'll hold off on changing it until it's TW approved in one of the other SDKs.

   /**
   * 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;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! I believe I approved this in one of the other SDKs as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release:stage Stage a release candidate release-note

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants