BroadcastOptions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Helper class for building an options Bundle that can be used with Context.sendBroadcast(Intent) and related methods.
[Android.Runtime.Register("android/app/BroadcastOptions", ApiSince=34, DoNotGenerateAcw=true)]
public class BroadcastOptions : Java.Lang.Object[<Android.Runtime.Register("android/app/BroadcastOptions", ApiSince=34, DoNotGenerateAcw=true)>]
type BroadcastOptions = class
inherit Object- Inheritance
- Attributes
Remarks
Helper class for building an options Bundle that can be used with Context.sendBroadcast(Intent) and related methods.
Android reference for android.app.BroadcastOptions.
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.
Constructors
| Name | Description |
|---|---|
| BroadcastOptions(IntPtr, JniHandleOwnership) |
Initializes a managed representation of an existing Java Native Interface object. |
Fields
| Name | Description |
|---|---|
| DeferralPolicyDefault |
Obsolete.
Deferral policy that indicates no desire has been expressed, and that the system should use a reasonable default behavior. |
| DeferralPolicyNone |
Obsolete.
Deferral policy that indicates a strong desire that no receiver of this broadcast should be deferred. |
| DeferralPolicyUntilActive |
Obsolete.
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. |
| DeliveryGroupPolicyAll |
Obsolete.
Delivery group policy that indicates that all the broadcasts in the delivery group need to be delivered as is. |
| DeliveryGroupPolicyMostRecent |
Obsolete.
Delivery group policy that indicates that only the most recent broadcast in the delivery group need to be delivered and the rest can be dropped. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| DeferralPolicy |
Gets deferral policy for this broadcast that specifies how this broadcast can be deferred for delivery at some future point. |
| DeliveryGroupMatchingKey |
Return the namespace and key that is used to identify the delivery group that this broadcast belongs to. |
| DeliveryGroupPolicy |
Get the delivery group policy for this broadcast that specifies how multiple broadcasts belonging to the same delivery group has to be handled. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| IsShareIdentityEnabled |
Returns whether the broadcasting app has opted-in to sharing its identity with the receiver. |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState | (Inherited from JavaObject) |
| JniPeerMembers |
Provides JNI binding infrastructure for Android.App.BroadcastOptions. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| ThresholdClass |
Provides JNI binding infrastructure for Android.App.BroadcastOptions. |
| ThresholdType |
Provides JNI binding infrastructure for Android.App.BroadcastOptions. |
Methods
| Name | Description |
|---|---|
| ClearDeferralPolicy() |
Clears any deferral policy for this broadcast that specifies how this broadcast can be deferred for delivery at some future point. |
| ClearDeliveryGroupMatchingKey() |
Clears the namespace and key that was previously set using setDeliveryGroupMatchingKey(String,String). |
| ClearDeliveryGroupPolicy() |
Clears any previously set delivery group policies using setDeliveryGroupMatchingKey(String,String) and resets the delivery group policy to the default value (DELIVERY_GROUP_POLICY_ALL). |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() | (Inherited from JavaObject) |
| Equals(Object) | (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| FromBundle(Bundle) |
Returns a BroadcastOptions parsed from the given Bundle, typically generated from toBundle(). |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| MakeBasic() |
Creates a basic BroadcastOptions with no options initially set. |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetDeferralPolicy(BroadcastDeferralPolicy) |
Sets deferral policy for this broadcast that specifies how this broadcast can be deferred for delivery at some future point. |
| SetDeliveryGroupMatchingKey(String, String) |
Set namespace and key to identify the delivery group that this broadcast belongs to. |
| SetDeliveryGroupPolicy(BroadcastDeliveryGroupPolicy) |
Set delivery group policy for this broadcast to specify how multiple broadcasts belonging to the same delivery group has to be handled. |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| SetShareIdentityEnabled(Boolean) |
Sets whether the identity of the broadcasting app should be shared with all receivers that will receive this broadcast. |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToBundle() |
Returns the created options as a Bundle, which can be passed to Context.sendBroadcast(Intent) and related methods. |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() | (Inherited from JavaObject) |
| IJavaPeerable.Finalized() | (Inherited from JavaObject) |
| IJavaPeerable.JniObjectReferenceControlBlock | (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from JavaObject) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |