BroadcastReceiver Class

Definition

Namespace:: Android.Content

Assembly:: Mono.Android.dll

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.

Base class for code that receives and handles broadcast intents sent by android.content.Context#sendBroadcast(Intent).

[Android.Runtime.Register("android/content/BroadcastReceiver", DoNotGenerateAcw=true)]
public abstract class BroadcastReceiver : Java.Lang.Object

[<Android.Runtime.Register("android/content/BroadcastReceiver", DoNotGenerateAcw=true)>]
type BroadcastReceiver = class
    inherit Object

Inheritance: Object

JavaObject

Object
BroadcastReceiver

Derived: Android.App.Admin.DelegatedAdminReceiver

Android.App.Admin.DeviceAdminReceiver

Android.App.Admin.PolicyUpdateReceiver

Android.Appwidget.AppWidgetProvider

Android.Service.Restrictions.RestrictionsReceiver

More…

Attributes: RegisterAttribute

Remarks

Base class for code that receives and handles broadcast intents sent by android.content.Context#sendBroadcast(Intent).

You can either dynamically register an instance of this class with Context#registerReceiver Context.registerReceiver() or statically declare an implementation with the android.R.styleable#AndroidManifestReceiver <receiver> tag in your AndroidManifest.xml.

<div class="special reference"> <h3>Developer Guides</h3>

For more information about using BroadcastReceiver, read the Broadcasts developer guide.

</div>

Java documentation for android.content.BroadcastReceiver.

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
BroadcastReceiver()	Initializes a broadcast receiver with no pending broadcast result.
BroadcastReceiver(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Name	Description
AbortBroadcast	Returns the flag indicating whether or not this receiver should abort the current broadcast.
Class	Returns the runtime class of this `Object`. (Inherited from Object)
DebugUnregister	Return the last value given to `#setDebugUnregister`. -or- Control inclusion of debugging help for mismatched calls to `Context#registerReceiver(BroadcastReceiver, IntentFilter) Context.registerReceiver()`.
Handle	The handle to the underlying Android instance. (Inherited from Object)
IsInitialStickyBroadcast	Returns true if the receiver is currently processing the initial value of a sticky broadcast -- that is, the value that was last broadcast and is currently held in the sticky cache, so this is not directly the result of a broadcast right now.
IsOrderedBroadcast	Returns true if the receiver is currently processing an ordered broadcast.
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	Gets the state flags last assigned by the runtime. (Inherited from JavaObject)
JniPeerMembers	Gets the JNI metadata used to invoke members of this Java peer.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
ResultCode	Retrieve the current result code, as set by the previous receiver. -or- Change the current result code of this broadcast; only works with broadcasts sent through `Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast`.
ResultData	Retrieve the current result data, as set by the previous receiver. -or- Change the current result data of this broadcast; only works with broadcasts sent through `Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast`.
SentFromPackage	Returns the package name of the app that initially sent this broadcast.
SentFromUid	Returns the uid of the app that initially sent this broadcast.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Name	Description
ClearAbortBroadcast()	Clears the flag indicating that this receiver should abort the current broadcast.
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)	Delegates construction of this peer to the runtime's value manager. (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()	Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject)
Equals(Object)	Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetResultExtras(Boolean)	Retrieve the current result extra data, as set by the previous receiver.
GoAsync()	This can be called by an application in `#onReceive` to allow it to keep the broadcast active after returning from that function.
InvokeAbortBroadcast()	Sets the flag indicating that this receiver should abort the current broadcast; only works with broadcasts sent through `Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast`.
JavaFinalize()	Obsolete. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
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)
OnReceive(Context, Intent)	This method is called when the BroadcastReceiver is receiving an Intent broadcast.
PeekService(Context, Intent)	Provide a binder to an already-bound service.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetOrderedHint(Boolean)	For internal use, sets the hint about whether this BroadcastReceiver is running in ordered mode.
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)	Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject)
SetResult(Result, String, Bundle)	Change all of the result data returned from this broadcasts; only works with broadcasts sent through `Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast`.
SetResultExtras(Bundle)	Change the current result extras of this broadcast; only works with broadcasts sent through `Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast`.
ToArray<T>()	Creates a managed array from this Java array wrapper. (Inherited from Object)
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()	Marks this peer as disposed and calls `Dispose` with `disposing` set to `true`. (Inherited from JavaObject)
IJavaPeerable.Finalized()	Marks this peer as disposed and calls `Dispose` with `disposing` set to `false`. (Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock	Gets the native control-block pointer used by this peer. (Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)	Stores the identity hash code supplied by the runtime. (Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	Replaces the stored managed peer state flags. (Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)	Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject)

Extension Methods

Name	Description
GetJniTypeName(IJavaPeerable)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)	Reuses a compatible managed peer or obtains a wrapper of the requested type.
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to