Skip to content

Commit 4d1cc39

Browse files
authored
Clean up documentation. (#5155)
* Removed deprecated class documentation about upstream messaging. * Updated send deprecation wording to "FCM upstream messaging" to align with the standard naming. * Fixed spelling error.
1 parent 8fff029 commit 4d1cc39

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

firebase-messaging/src/main/java/com/google/firebase/messaging/FirebaseMessaging.java

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,6 @@
6565
* <p>In order to receive Firebase messages, declare an implementation of <br>
6666
* {@link FirebaseMessagingService} in the app manifest. To process messages, override base class
6767
* methods to handle any events required by the application.
68-
*
69-
* <p>Client apps can send <a
70-
* href="https://firebase.google.com/docs/cloud-messaging/android/upstream">upstream messages</a>
71-
* back to the app server using the XMPP-based Cloud Connection Server. For example:
72-
*
73-
* <pre>
74-
* FirebaseMessaging.getInstance().send(
75-
* new RemoteMessage.Builder(SENDER_ID + "&#64;fcm.googleapis.com")
76-
* .setMessageId(id)
77-
* .addData("key", "value")
78-
* .build());</pre>
7968
*/
8069
public class FirebaseMessaging {
8170

@@ -447,7 +436,7 @@ public Task<Void> deleteToken() {
447436
* <p>The subscribe operation is persisted and will be retried until successful.
448437
*
449438
* <p>This uses an FCM registration token to identify the app instance, generating one if it does
450-
* not exist (see {@link #getToken()}), which perodically sends data to the Firebase backend when
439+
* not exist (see {@link #getToken()}), which periodically sends data to the Firebase backend when
451440
* auto-init is enabled. To delete the data, delete the token ({@link #deleteToken}) and the
452441
* Firebase Installations ID ({@code FirebaseInstallations.delete()}). To stop the periodic
453442
* sending of data, disable auto-init ({@link #setAutoInitEnabled}).
@@ -487,9 +476,9 @@ public Task<Void> unsubscribeFromTopic(@NonNull String topic) {
487476
* <p>When there is an active connection the message will be sent immediately, otherwise the
488477
* message will be queued up to the time to live (TTL) set in the message.
489478
*
490-
* @deprecated FCM upstream is deprecated and will be decommissioned in June 2024. Learn more in
491-
* the <a href="https://firebase.google.com/support/faq#fcm-23-deprecation">FAQ about FCM
492-
* features deprecated in June 2023</a>.
479+
* @deprecated FCM upstream messaging is deprecated and will be decommissioned in June 2024. Learn
480+
* more in the <a href="https://firebase.google.com/support/faq#fcm-23-deprecation">FAQ about
481+
* FCM features deprecated in June 2023</a>.
493482
*/
494483
@Deprecated
495484
public void send(@NonNull RemoteMessage message) {

0 commit comments

Comments
 (0)