Skip to content

Some App Distribution javadoc updates #4740

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 2, 2023
Merged

Some App Distribution javadoc updates #4740

merged 1 commit into from
Mar 2, 2023

Conversation

lfkellogg
Copy link
Contributor

@lfkellogg lfkellogg commented Mar 2, 2023 •
edited
Loading

Based on feedback from @rachelsaunders.

@google-oss-bot
Copy link
Contributor

1 Warning
⚠️ Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

@google-oss-bot
Copy link
Contributor

Coverage Report 1

Affected Products

No changes between base commit (990f27f) and merge commit (4cb67b0).

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/InRc4K8C7M.html

@github-actions
Copy link
Contributor

github-actions bot commented Mar 2, 2023

Unit Test Results

  36 files   -    725    36 suites   - 725   1m 55s ⏱️ - 31m 12s
183 tests  - 4 623  183 ✔️  - 4 601  0 💤  - 21  0 ❌  - 1 
366 runs   - 8 684  366 ✔️  - 8 641  0 💤  - 42  0 ❌  - 1 

Results for commit 55ffeb6. ± Comparison against base commit 990f27f.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 2, 2023

Javadoc Changes: 
--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html	2023-03-02 18:55:05.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html	2023-03-02 18:50:05.000000000 +0000
@@ -32,7 +32,7 @@
             <td><code>abstract void</code></td>
             <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html#cancelFeedbackNotification()">cancelFeedbackNotification</a>()</code></div>
-              <p>Hides the notification shown with showFeedbackNotification.</p>
+              <p>Hides the notification shown with <code><a href="/docs/reference/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(int,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a></code> or <code><a href="/docs/reference/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(java.lang.CharSequence,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a></code>.</p>
             </td>
           </tr>
           <tr>
@@ -134,7 +134,7 @@
       <div class="api-item"><a name="cancelFeedbackNotification--"></a><a name="cancelfeedbacknotification"></a>
         <h3 class="api-name" id="cancelFeedbackNotification()">cancelFeedbackNotification</h3>
         <pre class="api-signature no-pretty-print">abstract&nbsp;void&nbsp;<a href="/docs/reference/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html#cancelFeedbackNotification()">cancelFeedbackNotification</a>()</pre>
-        <p>Hides the notification shown with showFeedbackNotification.</p>
+        <p>Hides the notification shown with <code><a href="/docs/reference/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(int,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a></code> or <code><a href="/docs/reference/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(java.lang.CharSequence,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a></code>.</p>
       </div>
       <div class="api-item"><a name="checkForNewRelease--"></a><a name="checkfornewrelease"></a>
         <h3 class="api-name" id="checkForNewRelease()">checkForNewRelease</h3>
@@ -157,12 +157,13 @@
         <h3 class="api-name" id="showFeedbackNotification(java.lang.CharSequence,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</h3>
         <pre class="api-signature no-pretty-print">abstract&nbsp;void&nbsp;<a href="/docs/reference/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(java.lang.CharSequence,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/CharSequence.html">CharSequence</a>&nbsp;additionalFormText,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appdistribution/InterruptionLevel.html">InterruptionLevel</a>&nbsp;interruptionLevel<br>)</pre>
         <p>Displays a notification that, when tapped, will take a screenshot of the current activity, then start a new activity to collect and submit feedback from the tester along with the screenshot. </p>
-        <p>On Android 13 and above, this method requires the <a href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime permission for sending notifications</a>: <code>POST_NOTIFICATIONS</code>. If your app targets Android 13 (API level 33) or above, you should <a href="https://developer.android.com/training/permissions/requesting">request the permission</a>. </p>
+        <p>On Android 13 and above, this method requires the runtime permission for sending notifications: <a href="https://developer.android.com/develop/ui/views/notifications/notification-permission"><code>
+POST_NOTIFICATIONS</code></a>. If your app targets Android 13 (API level 33) or above, you should <a href="https://developer.android.com/training/permissions/requesting">request the permission</a>. </p>
         <p>When the notification is tapped: </p>
         <ol>
-          <li>If the app is open, take a screenshot of the current activity </li>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>If the app is open, takes a screenshot of the current activity. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -185,7 +186,7 @@
               <tr>
                 <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appdistribution/InterruptionLevel.html">InterruptionLevel</a>&nbsp;interruptionLevel</code></td>
                 <td>
-                  <p>the level of interruption for the feedback notification. On platforms below Android 8, this corresponds to a notification channel importance and once set cannot be changed except by the user.</p>
+                  <p>the level of interruption for the feedback notification. On platforms below Android 8, this corresponds to a <a href="https://developer.android.com/develop/ui/views/notifications/channels#importance">notification channel importance</a> and once set cannot be changed except by the user.</p>
                 </td>
               </tr>
             </tbody>
@@ -196,12 +197,13 @@
         <h3 class="api-name" id="showFeedbackNotification(int,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</h3>
         <pre class="api-signature no-pretty-print">abstract&nbsp;void&nbsp;<a href="/docs/reference/android/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(int,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/StringRes.html">StringRes</a> int&nbsp;additionalFormText,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appdistribution/InterruptionLevel.html">InterruptionLevel</a>&nbsp;interruptionLevel<br>)</pre>
         <p>Displays a notification that, when tapped, will take a screenshot of the current activity, then start a new activity to collect and submit feedback from the tester along with the screenshot. </p>
-        <p>On Android 13 and above, this method requires the <a href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime permission for sending notifications</a>: <code>POST_NOTIFICATIONS</code>. If your app targets Android 13 (API level 33) or above, you should <a href="https://developer.android.com/training/permissions/requesting">request the permission</a>. </p>
+        <p>On Android 13 and above, this method requires the runtime permission for sending notifications: <a href="https://developer.android.com/develop/ui/views/notifications/notification-permission"><code>
+POST_NOTIFICATIONS</code></a>. If your app targets Android 13 (API level 33) or above, you should <a href="https://developer.android.com/training/permissions/requesting">request the permission</a>. </p>
         <p>When the notification is tapped: </p>
         <ol>
-          <li>If the app is open, take a screenshot of the current activity </li>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>If the app is open, takes a screenshot of the current activity. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -224,7 +226,7 @@
               <tr>
                 <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/appdistribution/InterruptionLevel.html">InterruptionLevel</a>&nbsp;interruptionLevel</code></td>
                 <td>
-                  <p>the level of interruption for the feedback notification. On platforms below Android 8, this corresponds to a notification channel importance and once set cannot be changed except by the user.</p>
+                  <p>the level of interruption for the feedback notification. On platforms below Android 8, this corresponds to a <a href="https://developer.android.com/develop/ui/views/notifications/channels#importance">notification channel importance</a> and once set cannot be changed except by the user.</p>
                 </td>
               </tr>
             </tbody>
@@ -249,9 +251,9 @@
         <p>Takes a screenshot, and starts an activity to collect and submit feedback from the tester. </p>
         <p>Performs the following actions: </p>
         <ol>
-          <li>Takes a screenshot of the current activity </li>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>Takes a screenshot of the current activity. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -281,9 +283,9 @@
         <p>Takes a screenshot, and starts an activity to collect and submit feedback from the tester. </p>
         <p>Performs the following actions: </p>
         <ol>
-          <li>Takes a screenshot of the current activity </li>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>Takes a screenshot of the current activity. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -313,8 +315,8 @@
         <p>Starts an activity to collect and submit feedback from the tester, along with the given screenshot. </p>
         <p>Performs the following actions: </p>
         <ol>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -350,8 +352,8 @@
         <p>Starts an activity to collect and submit feedback from the tester, along with the given screenshot. </p>
         <p>Performs the following actions: </p>
         <ol>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -395,7 +397,7 @@
         <p>Updates the app to the newest release, if one is available. </p>
         <p>Returns the release information or <code>null</code> if no update is found. Performs the following actions: </p>
         <ol>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
           <li>Checks if a newer release is available. If so, presents the tester with a confirmation dialog to begin the download. </li>
           <li>If the newest release is an APK, downloads the binary and starts an installation. If the newest release is an AAB, directs the tester to the Play app to complete the download and installation. </li>
         </ol>
--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html	2023-03-02 18:55:05.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html	2023-03-02 18:50:05.000000000 +0000
@@ -32,7 +32,7 @@
             <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html#cancelFeedbackNotification()">cancelFeedbackNotification</a>()</code></div>
-              <p>Hides the notification shown with showFeedbackNotification.</p>
+              <p>Hides the notification shown with <code><a href="/docs/reference/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(int,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a></code> or <code><a href="/docs/reference/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(java.lang.CharSequence,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a></code>.</p>
             </td>
           </tr>
           <tr>
@@ -134,7 +134,7 @@
       <div class="api-item"><a name="cancelFeedbackNotification--"></a><a name="cancelfeedbacknotification"></a>
         <h3 class="api-name" id="cancelFeedbackNotification()">cancelFeedbackNotification</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html#cancelFeedbackNotification()">cancelFeedbackNotification</a>():&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
-        <p>Hides the notification shown with showFeedbackNotification.</p>
+        <p>Hides the notification shown with <code><a href="/docs/reference/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(int,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a></code> or <code><a href="/docs/reference/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(java.lang.CharSequence,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a></code>.</p>
       </div>
       <div class="api-item"><a name="checkForNewRelease--"></a><a name="checkfornewrelease"></a>
         <h3 class="api-name" id="checkForNewRelease()">checkForNewRelease</h3>
@@ -157,12 +157,13 @@
         <h3 class="api-name" id="showFeedbackNotification(java.lang.CharSequence,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(java.lang.CharSequence,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;additionalFormText:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html">CharSequence</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;interruptionLevel:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appdistribution/InterruptionLevel.html">InterruptionLevel</a><br>):&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
         <p>Displays a notification that, when tapped, will take a screenshot of the current activity, then start a new activity to collect and submit feedback from the tester along with the screenshot. </p>
-        <p>On Android 13 and above, this method requires the <a href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime permission for sending notifications</a>: <code>POST_NOTIFICATIONS</code>. If your app targets Android 13 (API level 33) or above, you should <a href="https://developer.android.com/training/permissions/requesting">request the permission</a>. </p>
+        <p>On Android 13 and above, this method requires the runtime permission for sending notifications: <a href="https://developer.android.com/develop/ui/views/notifications/notification-permission"><code>
+POST_NOTIFICATIONS</code></a>. If your app targets Android 13 (API level 33) or above, you should <a href="https://developer.android.com/training/permissions/requesting">request the permission</a>. </p>
         <p>When the notification is tapped: </p>
         <ol>
-          <li>If the app is open, take a screenshot of the current activity </li>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>If the app is open, takes a screenshot of the current activity. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -185,7 +186,7 @@
               <tr>
                 <td><code>interruptionLevel:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appdistribution/InterruptionLevel.html">InterruptionLevel</a></code></td>
                 <td>
-                  <p>the level of interruption for the feedback notification. On platforms below Android 8, this corresponds to a notification channel importance and once set cannot be changed except by the user.</p>
+                  <p>the level of interruption for the feedback notification. On platforms below Android 8, this corresponds to a <a href="https://developer.android.com/develop/ui/views/notifications/channels#importance">notification channel importance</a> and once set cannot be changed except by the user.</p>
                 </td>
               </tr>
             </tbody>
@@ -196,12 +197,13 @@
         <h3 class="api-name" id="showFeedbackNotification(int,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appdistribution/FirebaseAppDistribution.html#showFeedbackNotification(int,com.google.firebase.appdistribution.InterruptionLevel)">showFeedbackNotification</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;additionalFormText:&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/StringRes.html">StringRes</a> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;interruptionLevel:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appdistribution/InterruptionLevel.html">InterruptionLevel</a><br>):&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
         <p>Displays a notification that, when tapped, will take a screenshot of the current activity, then start a new activity to collect and submit feedback from the tester along with the screenshot. </p>
-        <p>On Android 13 and above, this method requires the <a href="https://developer.android.com/develop/ui/views/notifications/notification-permission">runtime permission for sending notifications</a>: <code>POST_NOTIFICATIONS</code>. If your app targets Android 13 (API level 33) or above, you should <a href="https://developer.android.com/training/permissions/requesting">request the permission</a>. </p>
+        <p>On Android 13 and above, this method requires the runtime permission for sending notifications: <a href="https://developer.android.com/develop/ui/views/notifications/notification-permission"><code>
+POST_NOTIFICATIONS</code></a>. If your app targets Android 13 (API level 33) or above, you should <a href="https://developer.android.com/training/permissions/requesting">request the permission</a>. </p>
         <p>When the notification is tapped: </p>
         <ol>
-          <li>If the app is open, take a screenshot of the current activity </li>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>If the app is open, takes a screenshot of the current activity. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -224,7 +226,7 @@
               <tr>
                 <td><code>interruptionLevel:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appdistribution/InterruptionLevel.html">InterruptionLevel</a></code></td>
                 <td>
-                  <p>the level of interruption for the feedback notification. On platforms below Android 8, this corresponds to a notification channel importance and once set cannot be changed except by the user.</p>
+                  <p>the level of interruption for the feedback notification. On platforms below Android 8, this corresponds to a <a href="https://developer.android.com/develop/ui/views/notifications/channels#importance">notification channel importance</a> and once set cannot be changed except by the user.</p>
                 </td>
               </tr>
             </tbody>
@@ -249,9 +251,9 @@
         <p>Takes a screenshot, and starts an activity to collect and submit feedback from the tester. </p>
         <p>Performs the following actions: </p>
         <ol>
-          <li>Takes a screenshot of the current activity </li>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>Takes a screenshot of the current activity. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -281,9 +283,9 @@
         <p>Takes a screenshot, and starts an activity to collect and submit feedback from the tester. </p>
         <p>Performs the following actions: </p>
         <ol>
-          <li>Takes a screenshot of the current activity </li>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>Takes a screenshot of the current activity. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -313,8 +315,8 @@
         <p>Starts an activity to collect and submit feedback from the tester, along with the given screenshot. </p>
         <p>Performs the following actions: </p>
         <ol>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -350,8 +352,8 @@
         <p>Starts an activity to collect and submit feedback from the tester, along with the given screenshot. </p>
         <p>Performs the following actions: </p>
         <ol>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI </li>
-          <li>Starts a full screen activity for the tester to compose and submit the feedback </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>Starts a full screen activity for the tester to compose and submit the feedback. </li>
         </ol>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -395,7 +397,7 @@
         <p>Updates the app to the newest release, if one is available. </p>
         <p>Returns the release information or <code>null</code> if no update is found. Performs the following actions: </p>
         <ol>
-          <li>If tester is not signed in, presents the tester with a Google Sign-in UI. </li>
+          <li>If the tester is not signed in, presents the tester with a Google Sign-in UI. </li>
           <li>Checks if a newer release is available. If so, presents the tester with a confirmation dialog to begin the download. </li>
           <li>If the newest release is an APK, downloads the binary and starts an installation. If the newest release is an AAB, directs the tester to the Play app to complete the download and installation. </li>
         </ol>

@google-oss-bot
Copy link
Contributor

Size Report 1

Affected Products

  • firebase-appdistribution-api

    TypeBase (990f27f)Merge (4cb67b0)Diff
    aar16.0 kB16.0 kB+2 B (+0.0%)
    apk (release)1.27 MB1.27 MB-4 B (-0.0%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/nS0yLAFjgn.html

@lfkellogg lfkellogg marked this pull request as ready for review March 2, 2023 18:59
@google-oss-bot
Copy link
Contributor

Startup Time Report 1

Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS.

Notes

Startup Times

  • fire-appdistribution

    DeviceStatisticsDistributions
    oriole-32
    Percentile990f27f4cb67b0DiffSignificant (?)
    p101.20 ±0.9 ms906 ±860 μs-291 μs (-24.3%)NO
    p251.25 ±0.9 ms948 ±901 μs-303 μs (-24.2%)NO
    p501.35 ±1 ms1.03 ±1 ms-316 μs (-23.4%)NO
    p751.56 ±1 ms1.21 ±1 ms-353 μs (-22.6%)NO
    p901.87 ±1 ms1.48 ±1 ms-390 μs (-20.8%)NO

    20 test runs in comparison
    CommitTest Runs
    990f27f
    • 2023-03-01_17:29:56.091997_todx
    • 2023-03-01_17:29:56.096238_xLdq
    • 2023-03-01_17:29:56.096260_eZmA
    • 2023-03-01_17:29:56.096269_EuFh
    • 2023-03-01_17:29:56.096276_GSPk
    • 2023-03-01_17:29:56.096283_nTtQ
    • 2023-03-01_17:29:56.096289_GFhP
    • 2023-03-01_17:29:56.096299_ZOmt
    • 2023-03-01_17:29:56.096305_nfFa
    • 2023-03-01_17:29:56.096312_nWkY
    4cb67b0
    • 2023-03-02_19:01:20.124768_bJmn
    • 2023-03-02_19:01:20.126605_CZZY
    • 2023-03-02_19:01:20.126616_kqmb
    • 2023-03-02_19:01:20.126622_tbDA
    • 2023-03-02_19:01:20.126628_aiAW
    • 2023-03-02_19:01:20.126633_wluc
    • 2023-03-02_19:01:20.126639_sIoe
    • 2023-03-02_19:01:20.126648_bOQo
    • 2023-03-02_19:01:20.126653_Dkzw
    • 2023-03-02_19:01:20.126659_mMvP
    redfin-30
    Percentile990f27f4cb67b0DiffSignificant (?)
    p102.89 ±2 ms2.17 ±2 ms-718 μs (-24.8%)NO
    p253.05 ±2 ms2.27 ±2 ms-773 μs (-25.4%)NO
    p503.25 ±2 ms2.41 ±2 ms-840 μs (-25.9%)NO
    p753.51 ±2 ms2.59 ±2 ms-927 μs (-26.4%)NO
    p904.10 ±3 ms2.83 ±3 ms-1.27 ms (-30.9%)NO

    20 test runs in comparison
    CommitTest Runs
    990f27f
    • 2023-03-01_17:29:56.091997_todx
    • 2023-03-01_17:29:56.096238_xLdq
    • 2023-03-01_17:29:56.096260_eZmA
    • 2023-03-01_17:29:56.096269_EuFh
    • 2023-03-01_17:29:56.096276_GSPk
    • 2023-03-01_17:29:56.096283_nTtQ
    • 2023-03-01_17:29:56.096289_GFhP
    • 2023-03-01_17:29:56.096299_ZOmt
    • 2023-03-01_17:29:56.096305_nfFa
    • 2023-03-01_17:29:56.096312_nWkY
    4cb67b0
    • 2023-03-02_19:01:20.124768_bJmn
    • 2023-03-02_19:01:20.126605_CZZY
    • 2023-03-02_19:01:20.126616_kqmb
    • 2023-03-02_19:01:20.126622_tbDA
    • 2023-03-02_19:01:20.126628_aiAW
    • 2023-03-02_19:01:20.126633_wluc
    • 2023-03-02_19:01:20.126639_sIoe
    • 2023-03-02_19:01:20.126648_bOQo
    • 2023-03-02_19:01:20.126653_Dkzw
    • 2023-03-02_19:01:20.126659_mMvP

  • timeToInitialDisplay

    DeviceStatisticsDistributions
    oriole-32
    Percentile990f27f4cb67b0DiffSignificant (?)
    p10197 ±9 ms203 ±14 ms+6.16 ms (+3.1%)NO
    p25205 ±9.6 ms211 ±17 ms+6.57 ms (+3.2%)NO
    p50213 ±13 ms220 ±20 ms+6.65 ms (+3.1%)NO
    p75226 ±22 ms233 ±28 ms+6.85 ms (+3.0%)NO
    p90238 ±27 ms247 ±31 ms+9.31 ms (+3.9%)NO

    20 test runs in comparison
    CommitTest Runs
    990f27f
    • 2023-03-01_17:29:56.091997_todx
    • 2023-03-01_17:29:56.096238_xLdq
    • 2023-03-01_17:29:56.096260_eZmA
    • 2023-03-01_17:29:56.096269_EuFh
    • 2023-03-01_17:29:56.096276_GSPk
    • 2023-03-01_17:29:56.096283_nTtQ
    • 2023-03-01_17:29:56.096289_GFhP
    • 2023-03-01_17:29:56.096299_ZOmt
    • 2023-03-01_17:29:56.096305_nfFa
    • 2023-03-01_17:29:56.096312_nWkY
    4cb67b0
    • 2023-03-02_19:01:20.124768_bJmn
    • 2023-03-02_19:01:20.126605_CZZY
    • 2023-03-02_19:01:20.126616_kqmb
    • 2023-03-02_19:01:20.126622_tbDA
    • 2023-03-02_19:01:20.126628_aiAW
    • 2023-03-02_19:01:20.126633_wluc
    • 2023-03-02_19:01:20.126639_sIoe
    • 2023-03-02_19:01:20.126648_bOQo
    • 2023-03-02_19:01:20.126653_Dkzw
    • 2023-03-02_19:01:20.126659_mMvP
    redfin-30
    Percentile990f27f4cb67b0DiffSignificant (?)
    p10230 ±4 ms253 ±8 ms+22.7 ms (+9.8%)MAYBE
    p25236 ±4 ms259 ±8 ms+22.9 ms (+9.7%)MAYBE
    p50243 ±4 ms267 ±9 ms+23.8 ms (+9.8%)MAYBE
    p75251 ±5 ms276 ±8 ms+25.0 ms (+10.0%)MAYBE
    p90259 ±6 ms288 ±9 ms+29.6 ms (+11.4%)MAYBE

    20 test runs in comparison
    CommitTest Runs
    990f27f
    • 2023-03-01_17:29:56.091997_todx
    • 2023-03-01_17:29:56.096238_xLdq
    • 2023-03-01_17:29:56.096260_eZmA
    • 2023-03-01_17:29:56.096269_EuFh
    • 2023-03-01_17:29:56.096276_GSPk
    • 2023-03-01_17:29:56.096283_nTtQ
    • 2023-03-01_17:29:56.096289_GFhP
    • 2023-03-01_17:29:56.096299_ZOmt
    • 2023-03-01_17:29:56.096305_nfFa
    • 2023-03-01_17:29:56.096312_nWkY
    4cb67b0
    • 2023-03-02_19:01:20.124768_bJmn
    • 2023-03-02_19:01:20.126605_CZZY
    • 2023-03-02_19:01:20.126616_kqmb
    • 2023-03-02_19:01:20.126622_tbDA
    • 2023-03-02_19:01:20.126628_aiAW
    • 2023-03-02_19:01:20.126633_wluc
    • 2023-03-02_19:01:20.126639_sIoe
    • 2023-03-02_19:01:20.126648_bOQo
    • 2023-03-02_19:01:20.126653_Dkzw
    • 2023-03-02_19:01:20.126659_mMvP

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/M4iepxDP1L/index.html

kaibolay
kaibolay approved these changes Mar 2, 2023
View reviewed changes
...tribution-api/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistribution.java
* Android 13 (API level 33) or above, you should <a
* <p>On Android 13 and above, this method requires the runtime permission for sending
* notifications: <a
* href="https://developer.android.com/develop/ui/views/notifications/notification-permission">{@code
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure if {@code …} inside <a>…</a> gets rendered properly. Consider using <pre>…</pre> instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, good question but from the Javadoc preview it looks like it correctly inserts a <code>...</code> which should work.

...tribution-api/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistribution.java
* Android 13 (API level 33) or above, you should <a
* <p>On Android 13 and above, this method requires the runtime permission for sending
* notifications: <a
* href="https://developer.android.com/develop/ui/views/notifications/notification-permission">{@code
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure if {@code …} inside <a>…</a> gets rendered properly. Consider using <pre>…</pre> instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ditto

@lfkellogg lfkellogg merged commit 22a45f6 into fad/next Mar 2, 2023
@lfkellogg lfkellogg deleted the lk/javadoc-updates branch March 2, 2023 21:55
lfkellogg added a commit that referenced this pull request Mar 14, 2023
@lfkellogg
Some App Distribution javadoc updates (#4740)
f6d7f2f
lfkellogg added a commit that referenced this pull request Mar 14, 2023
@lfkellogg
Some App Distribution javadoc updates (#4740)
05f8d44
lfkellogg added a commit that referenced this pull request Mar 14, 2023
@lfkellogg
Some App Distribution javadoc updates (#4740)
fa9649c
lfkellogg added a commit that referenced this pull request Mar 15, 2023
@lfkellogg
Merge fad/next into master to prepare for next release (#4784)
6d645d0 
* Some App Distribution javadoc updates (#4740)

* Support JPGs (in addition to PNGs) as feedback screenshots and set correct content-type/filename (#4783)

* Support PNGs as feedback screenshots

* Add tests and inject ContentResolver

* Address feedback

* Flip order of conditional

* Update changelog and version for M129
@firebase firebase locked and limited conversation to collaborators Apr 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kaibolay kaibolay kaibolay approved these changes

@rachelsaunders rachelsaunders Awaiting requested review from rachelsaunders

Assignees
No one assigned
Labels
size/M
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lfkellogg @google-oss-bot @kaibolay