Clean up documentation. #5155
Merged
Clean up documentation. #5155
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
gsakakihara
commented
Jul 11, 2023
gsakakihara
commented
- Removed deprecated class documentation about upstream messaging.
- Updated send deprecation wording to "FCM upstream messaging" to align with the standard naming.
- Fixed spelling error.
* Removed deprecated class documentation about upstream messaging. * Updated send deprecation wording to "FCM upstream messaging" to align with the standard naming. * Fixed spelling error.
Javadoc Changes:--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/messaging/FirebaseMessaging.html 2023-07-11 16:59:21.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/messaging/FirebaseMessaging.html 2023-07-11 16:54:12.000000000 +0000
@@ -13,12 +13,6 @@
<hr>
<p>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. </p>
<p>In order to receive Firebase messages, declare an implementation of <code><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessagingService.html">FirebaseMessagingService</a></code> in the app manifest. To process messages, override base class methods to handle any events required by the application. </p>
- <p>Client apps can send <a href="https://firebase.google.com/docs/cloud-messaging/android/upstream">upstream messages</a> back to the app server using the XMPP-based Cloud Connection Server. For example: </p>
- <pre class="prettyprint">FirebaseMessaging.getInstance().send(
- new RemoteMessage.Builder(SENDER_ID + "@fcm.googleapis.com")
- .setMessageId(id)
- .addData("key", "value")
-.build());</pre>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -102,7 +96,7 @@
<td>
<div><code><span><del><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#send(com.google.firebase.messaging.RemoteMessage)">send</a></del></span>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/messaging/RemoteMessage.html">RemoteMessage</a> message)</code></div>
<p><strong>This method is deprecated.</strong>
- <p>FCM upstream is deprecated and will be decommissioned in June 2024.</p>
+ <p>FCM upstream messaging is deprecated and will be decommissioned in June 2024.</p>
</p>
</td>
</tr>
@@ -278,7 +272,7 @@
<h3 class="api-name" id="send(com.google.firebase.messaging.RemoteMessage)">send</h3>
<pre class="api-signature no-pretty-print">public void <span><del><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#send(com.google.firebase.messaging.RemoteMessage)">send</a></del></span>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/messaging/RemoteMessage.html">RemoteMessage</a> message)</pre>
<aside class="caution"><strong>This method is deprecated.</strong><br>
- <p>FCM upstream 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>.</p>
+ <p>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>.</p>
</aside>
<p>Sends <code>message</code> upstream to your app server. </p>
<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.</p>
@@ -405,7 +399,7 @@
<pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Void.html">Void</a>> <a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#subscribeToTopic(java.lang.String)">subscribeToTopic</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> topic)</pre>
<p>Subscribes to <code>topic</code> in the background. </p>
<p>The subscribe operation is persisted and will be retried until successful. </p>
- <p>This uses an FCM registration token to identify the app instance, generating one if it does not exist (see <code><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#getToken()">getToken</a></code>), which perodically sends data to the Firebase backend when auto-init is enabled. To delete the data, delete the token (<code><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#deleteToken()">deleteToken</a></code>) and the Firebase Installations ID (<code>FirebaseInstallations.delete()</code>). To stop the periodic sending of data, disable auto-init (<code><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#setAutoInitEnabled(boolean)">setAutoInitEnabled</a></code>).</p>
+ <p>This uses an FCM registration token to identify the app instance, generating one if it does not exist (see <code><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#getToken()">getToken</a></code>), which periodically sends data to the Firebase backend when auto-init is enabled. To delete the data, delete the token (<code><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#deleteToken()">deleteToken</a></code>) and the Firebase Installations ID (<code>FirebaseInstallations.delete()</code>). To stop the periodic sending of data, disable auto-init (<code><a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessaging.html#setAutoInitEnabled(boolean)">setAutoInitEnabled</a></code>).</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/messaging/FirebaseMessaging.html 2023-07-11 16:59:21.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/messaging/FirebaseMessaging.html 2023-07-11 16:54:12.000000000 +0000
@@ -13,12 +13,6 @@
<hr>
<p>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. </p>
<p>In order to receive Firebase messages, declare an implementation of <code><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessagingService.html">FirebaseMessagingService</a></code> in the app manifest. To process messages, override base class methods to handle any events required by the application. </p>
- <p>Client apps can send <a href="https://firebase.google.com/docs/cloud-messaging/android/upstream">upstream messages</a> back to the app server using the XMPP-based Cloud Connection Server. For example: </p>
- <pre class="prettyprint">FirebaseMessaging.getInstance().send(
- new RemoteMessage.Builder(SENDER_ID + "@fcm.googleapis.com")
- .setMessageId(id)
- .addData("key", "value")
-.build());</pre>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -102,7 +96,7 @@
<td>
<div><code><span><del><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#send(com.google.firebase.messaging.RemoteMessage)">send</a></del></span>(message: <a href="/docs/reference/kotlin/com/google/firebase/messaging/RemoteMessage.html">RemoteMessage</a>)</code></div>
<p><strong>This function is deprecated.</strong>
- <p>FCM upstream is deprecated and will be decommissioned in June 2024.</p>
+ <p>FCM upstream messaging is deprecated and will be decommissioned in June 2024.</p>
</p>
</td>
</tr>
@@ -278,7 +272,7 @@
<h3 class="api-name" id="send(com.google.firebase.messaging.RemoteMessage)">send</h3>
<pre class="api-signature no-pretty-print">fun <span><del><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#send(com.google.firebase.messaging.RemoteMessage)">send</a></del></span>(message: <a href="/docs/reference/kotlin/com/google/firebase/messaging/RemoteMessage.html">RemoteMessage</a>): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
<aside class="caution"><strong>This function is deprecated.</strong><br>
- <p>FCM upstream 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>.</p>
+ <p>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>.</p>
</aside>
<p>Sends <code>message</code> upstream to your app server. </p>
<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.</p>
@@ -405,7 +399,7 @@
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#subscribeToTopic(java.lang.String)">subscribeToTopic</a>(topic: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Void.html">Void</a>!></pre>
<p>Subscribes to <code>topic</code> in the background. </p>
<p>The subscribe operation is persisted and will be retried until successful. </p>
- <p>This uses an FCM registration token to identify the app instance, generating one if it does not exist (see <code><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#getToken()">getToken</a></code>), which perodically sends data to the Firebase backend when auto-init is enabled. To delete the data, delete the token (<code><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#deleteToken()">deleteToken</a></code>) and the Firebase Installations ID (<code>FirebaseInstallations.delete()</code>). To stop the periodic sending of data, disable auto-init (<code><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#setAutoInitEnabled(boolean)">setAutoInitEnabled</a></code>).</p>
+ <p>This uses an FCM registration token to identify the app instance, generating one if it does not exist (see <code><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#getToken()">getToken</a></code>), which periodically sends data to the Firebase backend when auto-init is enabled. To delete the data, delete the token (<code><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#deleteToken()">deleteToken</a></code>) and the Firebase Installations ID (<code>FirebaseInstallations.delete()</code>). To stop the periodic sending of data, disable auto-init (<code><a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessaging.html#setAutoInitEnabled(boolean)">setAutoInitEnabled</a></code>).</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup> |
Coverage Report 1Affected Products
Test Logs |
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
willxu-google
approved these changes
Jul 11, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.