Changes from API review (#4675)

Author: lfkellogg

firebase-appdistribution-api/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistribution.java

@@ -14,7 +14,6 @@
 
 package com.google.firebase.appdistribution;
 
-import android.app.Activity;
 import android.net.Uri;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -125,12 +124,12 @@ public interface FirebaseAppDistribution {
    *   <li>Starts a full screen activity for the tester to compose and submit the feedback
    * </ol>
    *
-   * @param infoTextResourceId string resource ID of text that will be shown to the tester before
+   * @param additionalFormText string resource ID of text that will be shown to the tester before
    *     they submit feedback. If you’re a customer who would like to provide notice to your testers
    *     about collection and processing of their feedback data, you can use this text to provide
    *     such notice.
    */
-  void startFeedback(@StringRes int infoTextResourceId);
+  void startFeedback(@StringRes int additionalFormText);
 
   /**
    * Takes a screenshot, and starts an activity to collect and submit feedback from the tester.
@@ -143,11 +142,11 @@ public interface FirebaseAppDistribution {
    *   <li>Starts a full screen activity for the tester to compose and submit the feedback
    * </ol>
    *
-   * @param infoText text that will be shown to the tester before they submit feedback. If you’re a
-   *     customer who would like to provide notice to your testers about collection and processing
-   *     of their feedback data, you can use this text to provide such notice.
+   * @param additionalFormText text that will be shown to the tester before they submit feedback. If
+   *     you’re a customer who would like to provide notice to your testers about collection and
+   *     processing of their feedback data, you can use this text to provide such notice.
    */
-  void startFeedback(@NonNull CharSequence infoText);
+  void startFeedback(@NonNull CharSequence additionalFormText);
 
   /**
    * Starts an activity to collect and submit feedback from the tester, along with the given
@@ -160,14 +159,14 @@ public interface FirebaseAppDistribution {
    *   <li>Starts a full screen activity for the tester to compose and submit the feedback
    * </ol>
    *
-   * @param infoTextResourceId string resource ID of text that will be shown to the tester before
+   * @param additionalFormText string resource ID of text that will be shown to the tester before
    *     they submit feedback. If you’re a customer who would like to provide notice to your testers
    *     about collection and processing of their feedback data, you can use this text to provide
    *     such notice.
    * @param screenshot URI to a bitmap containing a screenshot that will be included with the
    *     report, or null to not include a screenshot
    */
-  void startFeedback(@StringRes int infoTextResourceId, @Nullable Uri screenshot);
+  void startFeedback(@StringRes int additionalFormText, @Nullable Uri screenshot);
 
   /**
    * Starts an activity to collect and submit feedback from the tester, along with the given
@@ -180,13 +179,13 @@ public interface FirebaseAppDistribution {
    *   <li>Starts a full screen activity for the tester to compose and submit the feedback
    * </ol>
    *
-   * @param infoText text that will be shown to the tester before they submit feedback. If you’re a
-   *     customer who would like to provide notice to your testers about collection and processing
-   *     of their feedback data, you can use this text to provide such notice.
+   * @param additionalFormText text that will be shown to the tester before they submit feedback. If
+   *     you’re a customer who would like to provide notice to your testers about collection and
+   *     processing of their feedback data, you can use this text to provide such notice.
    * @param screenshot URI to a bitmap containing a screenshot that will be included with the
    *     report, or null to not include a screenshot
    */
-  void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshot);
+  void startFeedback(@NonNull CharSequence additionalFormText, @Nullable Uri screenshot);
 
   /**
    * Displays a notification that, when tapped, will take a screenshot of the current activity, then
@@ -207,7 +206,7 @@ public interface FirebaseAppDistribution {
    *   <li>Starts a full screen activity for the tester to compose and submit the feedback
    * </ol>
    *
-   * @param infoTextResourceId string resource ID of text that will be shown to the tester before
+   * @param additionalFormText string resource ID of text that will be shown to the tester before
    *     they submit feedback. If you’re a customer who would like to provide notice to your testers
    *     about collection and processing of their feedback data, you can use this text to provide
    *     such notice.
@@ -216,7 +215,7 @@ public interface FirebaseAppDistribution {
    *     be changed except by the user.
    */
   void showFeedbackNotification(
-      @StringRes int infoTextResourceId, @NonNull InterruptionLevel interruptionLevel);
+      @StringRes int additionalFormText, @NonNull InterruptionLevel interruptionLevel);
 
   /**
    * Displays a notification that, when tapped, will take a screenshot of the current activity, then
@@ -237,22 +236,17 @@ void showFeedbackNotification(
    *   <li>Starts a full screen activity for the tester to compose and submit the feedback
    * </ol>
    *
-   * @param infoText text that will be shown to the tester before they submit feedback. If you’re a
-   *     customer who would like to provide notice to your testers about collection and processing
-   *     of their feedback data, you can use this text to provide such notice.
+   * @param additionalFormText text that will be shown to the tester before they submit feedback. If
+   *     you’re a customer who would like to provide notice to your testers about collection and
+   *     processing of their feedback data, you can use this text to provide such notice.
    * @param interruptionLevel 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.
    */
   void showFeedbackNotification(
-      @NonNull CharSequence infoText, @NonNull InterruptionLevel interruptionLevel);
+      @NonNull CharSequence additionalFormText, @NonNull InterruptionLevel interruptionLevel);
 
-  /**
-   * Hides the notification shown with {@link #showFeedbackNotification}.
-   *
-   * <p>This should be called in the {@link Activity#onDestroy} of the activity that showed the
-   * notification.
-   */
+  /** Hides the notification shown with {@link #showFeedbackNotification}. */
   void cancelFeedbackNotification();
 
   /** Gets the singleton {@link FirebaseAppDistribution} instance. */

firebase-appdistribution-api/src/main/java/com/google/firebase/appdistribution/internal/FirebaseAppDistributionProxy.java

@@ -77,35 +77,35 @@ public UpdateTask updateApp() {
   }
 
   @Override
-  public void startFeedback(@StringRes int infoTextResourceId) {
-    delegate.startFeedback(infoTextResourceId);
+  public void startFeedback(@StringRes int additionalFormText) {
+    delegate.startFeedback(additionalFormText);
   }
 
   @Override
-  public void startFeedback(@NonNull CharSequence infoText) {
-    delegate.startFeedback(infoText);
+  public void startFeedback(@NonNull CharSequence additionalFormText) {
+    delegate.startFeedback(additionalFormText);
   }
 
   @Override
-  public void startFeedback(@StringRes int infoTextResourceId, @Nullable Uri screenshotUri) {
-    delegate.startFeedback(infoTextResourceId, screenshotUri);
+  public void startFeedback(@StringRes int additionalFormText, @Nullable Uri screenshotUri) {
+    delegate.startFeedback(additionalFormText, screenshotUri);
   }
 
   @Override
-  public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshotUri) {
-    delegate.startFeedback(infoText, screenshotUri);
+  public void startFeedback(@NonNull CharSequence additionalFormText, @Nullable Uri screenshotUri) {
+    delegate.startFeedback(additionalFormText, screenshotUri);
   }
 
   @Override
   public void showFeedbackNotification(
-      @StringRes int infoTextResourceId, @NonNull InterruptionLevel interruptionLevel) {
-    delegate.showFeedbackNotification(infoTextResourceId, interruptionLevel);
+      @StringRes int additionalFormText, @NonNull InterruptionLevel interruptionLevel) {
+    delegate.showFeedbackNotification(additionalFormText, interruptionLevel);
   }
 
   @Override
   public void showFeedbackNotification(
-      @NonNull CharSequence infoText, @NonNull InterruptionLevel interruptionLevel) {
-    delegate.showFeedbackNotification(infoText, interruptionLevel);
+      @NonNull CharSequence additionalFormText, @NonNull InterruptionLevel interruptionLevel) {
+    delegate.showFeedbackNotification(additionalFormText, interruptionLevel);
   }
 
   @Override

firebase-appdistribution-api/src/main/java/com/google/firebase/appdistribution/internal/FirebaseAppDistributionStub.java

@@ -78,24 +78,25 @@ public UpdateTask updateApp() {
   }
 
   @Override
-  public void startFeedback(@StringRes int infoTextResourceId) {}
+  public void startFeedback(@StringRes int additionalFormText) {}
 
   @Override
-  public void startFeedback(@NonNull CharSequence infoText) {}
+  public void startFeedback(@NonNull CharSequence additionalFormText) {}
 
   @Override
-  public void startFeedback(@StringRes int infoTextResourceId, @Nullable Uri screenshotUri) {}
+  public void startFeedback(@StringRes int additionalFormText, @Nullable Uri screenshotUri) {}
 
   @Override
-  public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshotUri) {}
+  public void startFeedback(
+      @NonNull CharSequence additionalFormText, @Nullable Uri screenshotUri) {}
 
   @Override
   public void showFeedbackNotification(
-      @StringRes int infoTextResourceId, @NonNull InterruptionLevel interruptionLevel) {}
+      @StringRes int additionalFormText, @NonNull InterruptionLevel interruptionLevel) {}
 
   @Override
   public void showFeedbackNotification(
-      @NonNull CharSequence infoText, @NonNull InterruptionLevel interruptionLevel) {}
+      @NonNull CharSequence additionalFormText, @NonNull InterruptionLevel interruptionLevel) {}
 
   @Override
   public void cancelFeedbackNotification() {}

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/impl/FeedbackActivity.java

@@ -49,8 +49,8 @@ public class FeedbackActivity extends AppCompatActivity {
 
   public static final String RELEASE_NAME_KEY =
       "com.google.firebase.appdistribution.FeedbackActivity.RELEASE_NAME";
-  public static final String INFO_TEXT_KEY =
-      "com.google.firebase.appdistribution.FeedbackActivity.INFO_TEXT";
+  public static final String ADDITIONAL_FORM_TEXT_KEY =
+      "com.google.firebase.appdistribution.FeedbackActivity.ADDITIONAL_FORM_TEXT";
   public static final String SCREENSHOT_URI_KEY =
       "com.google.firebase.appdistribution.FeedbackActivity.SCREENSHOT_URI";
   public static final String FEEDBACK_TRIGGER_KEY =
@@ -64,7 +64,7 @@ public class FeedbackActivity extends AppCompatActivity {
   @Inject @UiThread Executor uiThreadExecutor;
 
   @Nullable private String releaseName; // in development-mode the releaseName might be null
-  private CharSequence infoText;
+  private CharSequence additionalFormText;
   @Nullable private Uri screenshotUri;
   private FeedbackTrigger feedbackTrigger;
 
@@ -77,7 +77,7 @@ protected void onCreate(Bundle savedInstanceState) {
 
     if (savedInstanceState != null) {
       releaseName = savedInstanceState.getString(RELEASE_NAME_KEY);
-      infoText = savedInstanceState.getCharSequence(INFO_TEXT_KEY);
+      additionalFormText = savedInstanceState.getCharSequence(ADDITIONAL_FORM_TEXT_KEY);
       feedbackTrigger =
           FeedbackTrigger.fromString(savedInstanceState.getString(FEEDBACK_TRIGGER_KEY));
       String screenshotUriString = savedInstanceState.getString(SCREENSHOT_URI_KEY);
@@ -86,7 +86,7 @@ protected void onCreate(Bundle savedInstanceState) {
       }
     } else {
       releaseName = getIntent().getStringExtra(RELEASE_NAME_KEY);
-      infoText = getIntent().getCharSequenceExtra(INFO_TEXT_KEY);
+      additionalFormText = getIntent().getCharSequenceExtra(ADDITIONAL_FORM_TEXT_KEY);
       feedbackTrigger =
           FeedbackTrigger.fromString(getIntent().getStringExtra(FEEDBACK_TRIGGER_KEY));
       if (getIntent().hasExtra(SCREENSHOT_URI_KEY)) {
@@ -100,7 +100,7 @@ protected void onCreate(Bundle savedInstanceState) {
   @Override
   protected void onSaveInstanceState(@NonNull Bundle outState) {
     outState.putString(RELEASE_NAME_KEY, releaseName);
-    outState.putCharSequence(INFO_TEXT_KEY, infoText);
+    outState.putCharSequence(ADDITIONAL_FORM_TEXT_KEY, additionalFormText);
     outState.putString(SCREENSHOT_URI_KEY, screenshotUri.toString());
     outState.putString(FEEDBACK_TRIGGER_KEY, feedbackTrigger.toString());
     super.onSaveInstanceState(outState);
@@ -110,9 +110,9 @@ private void setupView() {
     setTheme(R.style.FeedbackTheme);
     setContentView(R.layout.activity_feedback);
 
-    TextView infoTextView = this.findViewById(R.id.infoText);
-    infoTextView.setText(infoText);
-    infoTextView.setMovementMethod(LinkMovementMethod.getInstance());
+    TextView additionalFormTextView = this.findViewById(R.id.additionalFormText);
+    additionalFormTextView.setText(additionalFormText);
+    additionalFormTextView.setMovementMethod(LinkMovementMethod.getInstance());
 
     findViewById(R.id.backButton).setOnClickListener(v -> finish());
     findViewById(R.id.sendButton).setOnClickListener(this::submitFeedback);
@@ -146,7 +146,6 @@ private void setupScreenshot() {
                       v -> imageView.setVisibility(checkBox.isChecked() ? VISIBLE : GONE));
                 });
           } else {
-            LogWrapper.e(TAG, "No screenshot available");
             runOnUiThread(
                 () -> {
                   CheckBox checkBox = findViewById(R.id.screenshotCheckBox);
@@ -186,7 +185,7 @@ private Bitmap readScreenshot(@Nullable Uri uri) {
       return null;
     }
     if (bitmap == null) {
-      LogWrapper.e(TAG, "Could not decode screenshot image: " + uri);
+      LogWrapper.e(TAG, "Could not decode screenshot image from URI: " + uri);
     }
     return bitmap;
   }