Share via


BroadcastOptions.DeferralPolicyUntilActive Field

Definition

Caution

This constant will be removed in the future version. Use Android.App.BroadcastDeferralPolicy enum directly instead of this field.

Deferral policy that indicates a strong desire that each receiver of this broadcast should be deferred until that receiver's process is in an active (non-cached) state.

[Android.Runtime.Register("DEFERRAL_POLICY_UNTIL_ACTIVE", ApiSince=34)]
[System.Obsolete("This constant will be removed in the future version. Use Android.App.BroadcastDeferralPolicy enum directly instead of this field.", true)]
public const Android.App.BroadcastDeferralPolicy DeferralPolicyUntilActive = 2;
[<Android.Runtime.Register("DEFERRAL_POLICY_UNTIL_ACTIVE", ApiSince=34)>]
[<System.Obsolete("This constant will be removed in the future version. Use Android.App.BroadcastDeferralPolicy enum directly instead of this field.", true)>]
val mutable DeferralPolicyUntilActive : Android.App.BroadcastDeferralPolicy

Field Value

Value = 2
Attributes

Remarks

Deferral policy that indicates a strong desire that each receiver of this broadcast should be deferred until that receiver's process is in an active (non-cached) state. Whether an app's process state is considered active is independent of its standby bucket.

This policy only applies to runtime registered receivers of a broadcast, and does not apply to ordered broadcasts, alarm broadcasts, interactive broadcasts, or manifest broadcasts.

This policy means that a runtime registered receiver will not typically execute until that receiver's process is brought to an active state by some other action, such as a job, alarm, or service binding. As a result, the receiver may be delayed indefinitely.

When this policy is set on an unordered broadcast with a completion callback, the completion callback will run once all eligible processes have finished receiving the broadcast. Processes in inactive process state are not considered eligible and may not receive the broadcast prior to the completion callback.

Java documentation for android.app.BroadcastOptions.DEFERRAL_POLICY_UNTIL_ACTIVE.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to