diff options
| author | Ashwini Oruganti <ashfall@google.com> | 2020-09-29 21:42:26 +0000 |
|---|---|---|
| committer | Android (Google) Code Review <android-gerrit@google.com> | 2020-09-29 21:42:26 +0000 |
| commit | e813b7e800cc67f00e8ffaf711c7c4fc98c6ccbf (patch) | |
| tree | 172046a006745be1913ed0a5ad957218db2825fb /core/java | |
| parent | 0e3a1f8dae9287d9195480179c60ea940731b517 (diff) | |
| parent | 127e497477d56b4fa90b6f4400869742fd07d229 (diff) | |
Merge "Update docs to hint when to use FLAG_MUTABLE"
Diffstat (limited to 'core/java')
| -rw-r--r-- | core/java/android/app/PendingIntent.java | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/core/java/android/app/PendingIntent.java b/core/java/android/app/PendingIntent.java index 8e3ee0cbceff..e8937a8da911 100644 --- a/core/java/android/app/PendingIntent.java +++ b/core/java/android/app/PendingIntent.java @@ -199,7 +199,8 @@ public final class PendingIntent implements Parcelable { * either (@link #FLAG_IMMUTABLE} or {@link #FLAG_MUTABLE}. It is strongly * recommended to use {@link #FLAG_IMMUTABLE} when creating a * PendingIntent. {@link #FLAG_MUTABLE} should only be used when some - * functionality relies on modifying the underlying intent. + * functionality relies on modifying the underlying intent, e.g. any + * PendingIntent that needs to be used with inline reply or bubbles. */ public static final int FLAG_MUTABLE = 1<<25; @@ -320,7 +321,10 @@ public final class PendingIntent implements Parcelable { final boolean flagMutableSet = (flags & PendingIntent.FLAG_MUTABLE) != 0; String msg = packageName + ": Targeting S+ (version " + Build.VERSION_CODES.S + " and above) requires that one of FLAG_IMMUTABLE or FLAG_MUTABLE" - + " be specified when creating a PendingIntent"; + + " be specified when creating a PendingIntent.\nStrongly consider" + + " using FLAG_IMMUTABLE, only use FLAG_MUTABLE if some functionality" + + " depends on the PendingIntent being mutable, e.g. if it needs to" + + " be used with inline replies or bubbles."; if (flagImmutableSet && flagMutableSet) { throw new IllegalArgumentException( |