Notification trigger API

firebase-appdistribution-api/api.txt

@@ -14,14 +14,17 @@ package com.google.firebase.appdistribution {
   }
 
   public interface FirebaseAppDistribution {
+    method public void cancelFeedbackNotification();
     method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.appdistribution.AppDistributionRelease> checkForNewRelease();
     method @NonNull public static com.google.firebase.appdistribution.FirebaseAppDistribution getInstance();
     method public boolean isTesterSignedIn();
+    method public void showFeedbackNotification(@StringRes int, @NonNull com.google.firebase.appdistribution.InterruptionLevel);
+    method public void showFeedbackNotification(@NonNull CharSequence, @NonNull com.google.firebase.appdistribution.InterruptionLevel);
     method @NonNull public com.google.android.gms.tasks.Task<java.lang.Void> signInTester();
     method public void signOutTester();
-    method public void startFeedback(int);
+    method public void startFeedback(@StringRes int);
     method public void startFeedback(@NonNull CharSequence);
-    method public void startFeedback(@NonNull int, @Nullable android.net.Uri);
+    method public void startFeedback(@StringRes int, @Nullable android.net.Uri);
     method public void startFeedback(@NonNull CharSequence, @Nullable android.net.Uri);
     method @NonNull public com.google.firebase.appdistribution.UpdateTask updateApp();
     method @NonNull public com.google.firebase.appdistribution.UpdateTask updateIfNewReleaseAvailable();
@@ -46,6 +49,14 @@ package com.google.firebase.appdistribution {
     enum_constant public static final com.google.firebase.appdistribution.FirebaseAppDistributionException.Status UPDATE_NOT_AVAILABLE;
   }
 
+  public enum InterruptionLevel {
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel DEFAULT;
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel HIGH;
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel LOW;
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel MAX;
+    enum_constant public static final com.google.firebase.appdistribution.InterruptionLevel MIN;
+  }
+
   public interface OnProgressListener {
     method public void onProgressUpdate(@NonNull com.google.firebase.appdistribution.UpdateProgress);
   }

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

@@ -14,9 +14,11 @@
 
 package com.google.firebase.appdistribution;
 
+import android.app.Activity;
 import android.net.Uri;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.StringRes;
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.appdistribution.internal.FirebaseAppDistributionProxy;
@@ -34,6 +36,7 @@
  * <p>Call {@link #getInstance()} to get the singleton instance of {@link FirebaseAppDistribution}.
  */
 public interface FirebaseAppDistribution {
+
   /**
    * Updates the app to the newest release, if one is available.
    *
@@ -125,7 +128,7 @@ public interface FirebaseAppDistribution {
    * @param infoTextResourceId string resource ID of text to display to the tester before collecting
    *     feedback data (e.g. Terms and Conditions)
    */
-  void startFeedback(int infoTextResourceId);
+  void startFeedback(@StringRes int infoTextResourceId);
 
   /**
    * Takes a screenshot, and starts an activity to collect and submit feedback from the tester.
@@ -159,7 +162,7 @@ public interface FirebaseAppDistribution {
    * @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 int infoTextResourceId, @Nullable Uri screenshot);
+  void startFeedback(@StringRes int infoTextResourceId, @Nullable Uri screenshot);
 
   /**
    * Starts an activity to collect and submit feedback from the tester, along with the given
@@ -179,6 +182,70 @@ public interface FirebaseAppDistribution {
    */
   void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshot);
 
+  /**
+   * 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>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}. 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>When the notification is tapped:
+   *
+   * <ol>
+   *   <li>If the app is open, take a screenshot of the current activity
+   *   <li>If tester is not signed in, presents the tester with a Google Sign-in UI
+   *   <li>Starts a full screen activity for the tester to compose and submit the feedback
+   * </ol>
+   *
+   * @param infoTextResourceId string resource ID of text to display to the tester before collecting
+   *     feedback data (e.g. Terms and Conditions)
+   * @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(
+      @StringRes int infoTextResourceId, @NonNull InterruptionLevel interruptionLevel);
+
+  /**
+   * 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>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}. 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>When the notification is tapped:
+   *
+   * <ol>
+   *   <li>If the app is open, take a screenshot of the current activity
+   *   <li>If tester is not signed in, presents the tester with a Google Sign-in UI
+   *   <li>Starts a full screen activity for the tester to compose and submit the feedback
+   * </ol>
+   *
+   * @param infoText text to display to the tester before collecting feedback data (e.g. Terms and
+   *     Conditions)
+   * @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);
+
+  /**
+   * Hides the notification shown with {@link #showFeedbackNotification}.
+   *
+   * <p>This should be called in the {@link Activity#onDestroy} of the activity that showed the
+   * notification.
+   */
+  void cancelFeedbackNotification();
+
   /** Gets the singleton {@link FirebaseAppDistribution} instance. */
   @NonNull
   static FirebaseAppDistribution getInstance() {

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

@@ -0,0 +1,81 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.appdistribution;
+
+import android.app.NotificationManager;
+import androidx.core.app.NotificationCompat;
+
+/** An enum specifying the level of interruption of a notification when it is created. */
+public enum InterruptionLevel {
+
+  /**
+   * Minimum interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_MIN} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_MIN} on older platforms.
+   */
+  MIN(NotificationManager.IMPORTANCE_MIN, NotificationCompat.PRIORITY_MIN),
+
+  /**
+   * Low interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_LOW} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_LOW} on older platforms.
+   */
+  LOW(NotificationManager.IMPORTANCE_LOW, NotificationCompat.PRIORITY_LOW),
+
+  /**
+   * Default interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_DEFAULT} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_DEFAULT} on older platforms.
+   */
+  DEFAULT(NotificationManager.IMPORTANCE_DEFAULT, NotificationCompat.PRIORITY_DEFAULT),
+
+  /**
+   * High interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_HIGH} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_HIGH} on older platforms.
+   */
+  HIGH(NotificationManager.IMPORTANCE_HIGH, NotificationCompat.PRIORITY_HIGH),
+
+  /**
+   * Maximum interruption level.
+   *
+   * <p>Translates to {@link NotificationManager#IMPORTANCE_HIGH} on Android O+ and {@link
+   * NotificationCompat#PRIORITY_MAX} on older platforms.
+   */
+  MAX(NotificationManager.IMPORTANCE_HIGH, NotificationCompat.PRIORITY_MAX);
+
+  /**
+   * The notification channel importance corresponding to this interruption level on Android O+.
+   *
+   * @hide
+   */
+  public final int channelImportance;
+
+  /**
+   * The notification priority corresponding to this interruption level on older platforms.
+   *
+   * @hide
+   */
+  public final int notificationPriority;
+
+  InterruptionLevel(int channelImportance, int notificationPriority) {
+    this.channelImportance = channelImportance;
+    this.notificationPriority = notificationPriority;
+  }
+}

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

@@ -17,10 +17,12 @@
 import android.net.Uri;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.StringRes;
 import com.google.android.gms.tasks.Task;
 import com.google.firebase.appdistribution.AppDistributionRelease;
 import com.google.firebase.appdistribution.FirebaseAppDistribution;
 import com.google.firebase.appdistribution.FirebaseAppDistributionException;
+import com.google.firebase.appdistribution.InterruptionLevel;
 import com.google.firebase.appdistribution.UpdateTask;
 import com.google.firebase.inject.Provider;
 
@@ -75,7 +77,7 @@ public UpdateTask updateApp() {
   }
 
   @Override
-  public void startFeedback(int infoTextResourceId) {
+  public void startFeedback(@StringRes int infoTextResourceId) {
     delegate.startFeedback(infoTextResourceId);
   }
 
@@ -85,12 +87,29 @@ public void startFeedback(@NonNull CharSequence infoText) {
   }
 
   @Override
-  public void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screenshotUri) {
+  public void startFeedback(@StringRes int infoTextResourceId, @Nullable Uri screenshotUri) {
     delegate.startFeedback(infoTextResourceId, screenshotUri);
   }
 
   @Override
   public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshotUri) {
     delegate.startFeedback(infoText, screenshotUri);
   }
+
+  @Override
+  public void showFeedbackNotification(
+      @StringRes int infoTextResourceId, @NonNull InterruptionLevel interruptionLevel) {
+    delegate.showFeedbackNotification(infoTextResourceId, interruptionLevel);
+  }
+
+  @Override
+  public void showFeedbackNotification(
+      @NonNull CharSequence infoText, @NonNull InterruptionLevel interruptionLevel) {
+    delegate.showFeedbackNotification(infoText, interruptionLevel);
+  }
+
+  @Override
+  public void cancelFeedbackNotification() {
+    delegate.cancelFeedbackNotification();
+  }
 }

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

@@ -18,6 +18,7 @@
 import android.net.Uri;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.StringRes;
 import com.google.android.gms.tasks.Continuation;
 import com.google.android.gms.tasks.OnCanceledListener;
 import com.google.android.gms.tasks.OnCompleteListener;
@@ -30,6 +31,7 @@
 import com.google.firebase.appdistribution.FirebaseAppDistribution;
 import com.google.firebase.appdistribution.FirebaseAppDistributionException;
 import com.google.firebase.appdistribution.FirebaseAppDistributionException.Status;
+import com.google.firebase.appdistribution.InterruptionLevel;
 import com.google.firebase.appdistribution.OnProgressListener;
 import com.google.firebase.appdistribution.UpdateTask;
 import java.util.concurrent.Executor;
@@ -73,17 +75,28 @@ public UpdateTask updateApp() {
   }
 
   @Override
-  public void startFeedback(int infoTextResourceId) {}
+  public void startFeedback(@StringRes int infoTextResourceId) {}
 
   @Override
   public void startFeedback(@NonNull CharSequence infoText) {}
 
   @Override
-  public void startFeedback(@NonNull int infoTextResourceId, @Nullable Uri screenshotUri) {}
+  public void startFeedback(@StringRes int infoTextResourceId, @Nullable Uri screenshotUri) {}
 
   @Override
   public void startFeedback(@NonNull CharSequence infoText, @Nullable Uri screenshotUri) {}
 
+  @Override
+  public void showFeedbackNotification(
+      @StringRes int infoTextResourceId, @NonNull InterruptionLevel interruptionLevel) {}
+
+  @Override
+  public void showFeedbackNotification(
+      @NonNull CharSequence infoText, @NonNull InterruptionLevel interruptionLevel) {}
+
+  @Override
+  public void cancelFeedbackNotification() {}
+
   private static <TResult> Task<TResult> getNotImplementedTask() {
     return Tasks.forException(
         new FirebaseAppDistributionException(

firebase-appdistribution/src/main/AndroidManifest.xml

@@ -17,8 +17,9 @@
     package="com.google.firebase.appdistribution.impl">
 
     <uses-permission android:name="android.permission.INTERNET" />
-    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
+    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
 
     <application>
@@ -51,6 +52,10 @@
             android:exported="false"
             android:theme="@style/Theme.AppCompat.Light.NoActionBar" />
 
+        <activity
+            android:name=".TakeScreenshotAndStartFeedbackActivity"
+            android:exported="false" />
+
         <provider
             android:name="com.google.firebase.appdistribution.impl.FirebaseAppDistributionFileProvider"
             android:authorities="${applicationId}.FirebaseAppDistributionFileProvider"

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

@@ -307,7 +307,7 @@ private void postUpdateProgress(
               .build());
     }
     if (showNotification) {
-      appDistributionNotificationsManager.updateNotification(
+      appDistributionNotificationsManager.showAppUpdateNotification(
           totalBytes, downloadedBytes, stringResourceId);
     }
   }