Add documentation to onMessageReceived on the time to handle a message. #5147
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
Javadoc Changes:--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/messaging/FirebaseMessagingService.html 2023-07-07 18:33:27.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/messaging/FirebaseMessagingService.html 2023-07-07 18:28:31.000000000 +0000
@@ -1654,6 +1654,7 @@
<h3 class="api-name" id="onMessageReceived(com.google.firebase.messaging.RemoteMessage)">onMessageReceived</h3>
<pre class="api-signature no-pretty-print">@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/WorkerThread.html">WorkerThread</a><br>public void <a href="/docs/reference/android/com/google/firebase/messaging/FirebaseMessagingService.html#onMessageReceived(com.google.firebase.messaging.RemoteMessage)">onMessageReceived</a>(@<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>
<p>Called when a message is received. </p>
+ <p>This should complete within 20 seconds. Taking longer may interfere with your ability to complete your work and may affect pending messages. </p>
<p>This is also called when a notification message is received while the app is in the foreground. The notification parameters can be retrieved with <code><a href="/docs/reference/android/com/google/firebase/messaging/RemoteMessage.html#getNotification()">getNotification</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/messaging/FirebaseMessagingService.html 2023-07-07 18:33:27.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/messaging/FirebaseMessagingService.html 2023-07-07 18:28:31.000000000 +0000
@@ -1654,6 +1654,7 @@
<h3 class="api-name" id="onMessageReceived(com.google.firebase.messaging.RemoteMessage)">onMessageReceived</h3>
<pre class="api-signature no-pretty-print">@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/WorkerThread.html">WorkerThread</a><br>fun <a href="/docs/reference/kotlin/com/google/firebase/messaging/FirebaseMessagingService.html#onMessageReceived(com.google.firebase.messaging.RemoteMessage)">onMessageReceived</a>(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>
<p>Called when a message is received. </p>
+ <p>This should complete within 20 seconds. Taking longer may interfere with your ability to complete your work and may affect pending messages. </p>
<p>This is also called when a notification message is received while the app is in the foreground. The notification parameters can be retrieved with <code><a href="/docs/reference/kotlin/com/google/firebase/messaging/RemoteMessage.html#getNotification()">getNotification</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive"> |
Coverage Report 1Affected Products
Test Logs |
Size Report 1Affected Products
Test Logs |
gsakakihara
requested review from
James201311,
xiaohegong,
welishr and
willxu-google
willxu-google
approved these changes
Jul 7, 2023
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
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.
No description provided.