Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 30ad0ccb authored by Sudheer Shanka's avatar Sudheer Shanka
Browse files

Add BroadcastOptions.setDeferUntilActive() API. 

Bug: 255525222
Bug: 255545931
Test: TH
Change-Id: Ie340708389686182f10f210e7ca51b261e40df68
Merged-In: I9a356c8701d73f5687831fbe5b699e4485f07dd5
parent 667a49fe

core/api/system-current.txt

+2 −0
Original line number Diff line number Diff line
@@ -760,10 +760,12 @@ package android.app { 














  public class BroadcastOptions {















    method public void clearRequireCompatChange();













    method public boolean isDeferUntilActive();















    method public boolean isPendingIntentBackgroundActivityLaunchAllowed();















    method public static android.app.BroadcastOptions makeBasic();















    method @RequiresPermission(android.Manifest.permission.ACCESS_BROADCAST_RESPONSE_STATS) public void recordResponseEventWhileInBackground(@IntRange(from=0) long);















    method @RequiresPermission(android.Manifest.permission.START_ACTIVITIES_FROM_BACKGROUND) public void setBackgroundActivityStartsAllowed(boolean);













    method @NonNull public android.app.BroadcastOptions setDeferUntilActive(boolean);















    method public void setDeliveryGroupMatchingFilter(@NonNull android.content.IntentFilter);















    method public void setDeliveryGroupMatchingKey(@NonNull String, @NonNull String);















    method public void setDeliveryGroupPolicy(int);

























core/java/android/app/BroadcastOptions.java



+36
−0




























Original line number
Diff line number
Diff line








@@ -66,6 +66,7 @@ public class BroadcastOptions extends ComponentOptions {













    private @DeliveryGroupPolicy int mDeliveryGroupPolicy;















    private @Nullable String mDeliveryGroupMatchingKey;















    private @Nullable IntentFilter mDeliveryGroupMatchingFilter;













    private boolean mIsDeferUntilActive = false;































    /**















     * Change ID which is invalid.










@@ -687,6 +688,41 @@ public class BroadcastOptions extends ComponentOptions {













        mDeliveryGroupMatchingFilter = Objects.requireNonNull(matchingFilter);















    }





























    /**













     * Sets whether the broadcast should not run until the process is in an active process state













     * (ie, a process exists for the app and the app is not in a cached process state).













     *













     * Whether an app's process state is considered active is independent of its standby bucket.













     *













     * A broadcast that is deferred until the process is active will not execute until the process













     * is brought to an active state by some other action, like a job, alarm, or service binding. As













     * a result, the broadcast may be delayed indefinitely. This deferral only applies to runtime













     * registered receivers of a broadcast. Any manifest receivers will run immediately, similar to













     * how a manifest receiver would start a new process in order to run a broadcast receiver.













     *













     * Ordered broadcasts, alarm broadcasts, interactive broadcasts, and manifest broadcasts are













     * never deferred.













     *













     * Unordered broadcasts and unordered broadcasts with completion callbacks may be













     * deferred. Completion callbacks for broadcasts deferred until active are













     * best-effort. Completion callbacks will run when all eligible processes have finished













     * executing the broadcast. Processes in inactive process states that defer the broadcast are













     * not considered eligible and may not execute the broadcast prior to the completion callback.













     *













     * @hide













     */













    @SystemApi













    public @NonNull BroadcastOptions setDeferUntilActive(boolean shouldDefer) {













        mIsDeferUntilActive = shouldDefer;













        return this;













    }



























    /** @hide */













    @SystemApi













    public boolean isDeferUntilActive() {













        return mIsDeferUntilActive;













    }





























    /**















     * Returns the created options as a Bundle, which can be passed to















     * {@link android.content.Context#sendBroadcast(android.content.Intent)