Skip to content

Deprecate additional FCM upstream messaging methods. #6411

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.

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

Merged
merged 1 commit into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions firebase-messaging/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Unreleased
* [deprecated] Deprecated additional FCM upstream messaging methods. See the
[FAQ](https://firebase.google.com/support/faq#fcm-23-deprecation) for more
details.


# 24.0.3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@

/**
* Top level <a href="https://firebase.google.com/docs/cloud-messaging/">Firebase Cloud
* Messaging</a> singleton that provides methods for subscribing to topics and sending upstream
* messages.
* Messaging</a> singleton that provides methods for generating tokens and subscribing to topics.
*
* <p>In order to receive messages, declare an implementation of <br>
* {@link FirebaseMessagingService} in the app manifest. To process messages, override base class
Expand Down Expand Up @@ -515,9 +514,9 @@ public Task<Void> unsubscribeFromTopic(@NonNull String topic) {
* <p>When there is an active connection the message will be sent immediately, otherwise the
* message will be queued up to the time to live (TTL) set in the message.
*
* @deprecated FCM upstream messaging is deprecated and will be decommissioned in June 2024. Learn
* more in the <a href="https://firebase.google.com/support/faq#fcm-23-deprecation">FAQ about
* FCM features deprecated in June 2023</a>.
* @deprecated FCM upstream messaging is decommissioned. Learn more in the
* <a href="https://firebase.google.com/support/faq#fcm-23-deprecation">FAQ about FCM features
* deprecated in June 2023</a>.
*/
@Deprecated
public void send(@NonNull RemoteMessage message) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
* Base class for receiving messages from Firebase Cloud Messaging.
*
* <p>Extending this class is required to be able to handle downstream messages. It also provides
* functionality to automatically display notifications, and has methods that are invoked to give
* the status of upstream messages.
* functionality to automatically display notifications.
*
* <p>Override base class methods to handle any events required by the application. All methods are
* invoked on a background thread, and <em>may be called when the app is in the background or not
Expand Down Expand Up @@ -127,7 +126,12 @@ public void onDeletedMessages() {}
* Called when an upstream message has been successfully sent to the GCM connection server.
*
* @param msgId of the upstream message sent using {@link FirebaseMessaging#send}.
*
* @deprecated FCM upstream messaging is decommissioned. Learn more in the
* <a href="https://firebase.google.com/support/faq#fcm-23-deprecation">FAQ about FCM features
* deprecated in June 2023</a>.
*/
@Deprecated
@WorkerThread
public void onMessageSent(@NonNull String msgId) {}

Expand All @@ -136,7 +140,12 @@ public void onMessageSent(@NonNull String msgId) {}
*
* @param msgId of the upstream message sent using {@link FirebaseMessaging#send}.
* @param exception description of the error, typically a {@link SendException}.
*
* @deprecated FCM upstream messaging is decommissioned. Learn more in the
* <a href="https://firebase.google.com/support/faq#fcm-23-deprecation">FAQ about FCM features
* deprecated in June 2023</a>.
*/
@Deprecated
@WorkerThread
public void onSendError(@NonNull String msgId, @NonNull Exception exception) {}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,10 @@
/**
* A remote Firebase Message.
*
* <p>Messages will be received via {@link
* FirebaseMessagingService#onMessageReceived(RemoteMessage)} and can be sent via {@link
* FirebaseMessaging#send(RemoteMessage)}.
* <p>Messages will be received via {@link FirebaseMessagingService#onMessageReceived(RemoteMessage)}.
*
* <p>Messages may have a {@link Notification} instance if they are received while the application
* is in the foreground, otherwise they will be automatically posted to the notification tray.
*
* <p>Use the {@link Builder} class for building message instances to send via {@link
* FirebaseMessaging#send(RemoteMessage)}.
*/
@SafeParcelable.Reserved({1 /* version field removed by bot go/versionless-safeparcelable */})
@SafeParcelable.Class(creator = "RemoteMessageCreator")
Expand Down Expand Up @@ -115,11 +110,11 @@ public String getFrom() {
/**
* Gets the message destination.
*
* <ul>
* <li>For upstream messages, this will be of the form {@code [email protected]}.
* <li>For downstream messages, this will be the Firebase installations ID (FID).
* </ul>
* @deprecated FCM upstream messaging is decommissioned. Learn more in the
* <a href="https://firebase.google.com/support/faq#fcm-23-deprecation">FAQ about FCM features
* deprecated in June 2023</a>.
*/
@Deprecated
@Nullable
public String getTo() {
return bundle.getString(MessagePayloadKeys.TO);
Expand Down Expand Up @@ -373,13 +368,13 @@ public String getMessageType() {
/** @hide */
@Nullable
public String getCollapseKey() {
return bundle.getString(MessagePayloadKeys.MESSAGE_TYPE);
return bundle.getString(MessagePayloadKeys.COLLAPSE_KEY);
}

/** @hide */
@IntRange(from = 0, to = 86400)
public int getTtl() {
return Integer.parseInt(bundle.getString(MessagePayloadKeys.MESSAGE_TYPE, "0"));
return Integer.parseInt(bundle.getString(MessagePayloadKeys.TTL, "0"));
}

/** @hide */
Expand Down
Loading