AppWidgetProvider Class

Reference

Definition

Namespace:: Android.Appwidget

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.

A convenience class to aid in implementing an AppWidget provider.

[Android.Runtime.Register("android/appwidget/AppWidgetProvider", DoNotGenerateAcw=true)]
public class AppWidgetProvider : Android.Content.BroadcastReceiver

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

Inheritance: Object

Object

BroadcastReceiver
AppWidgetProvider

Attributes: RegisterAttribute

Remarks

A convenience class to aid in implementing an AppWidget provider. Everything you can do with AppWidgetProvider, you can do with a regular BroadcastReceiver. AppWidgetProvider merely parses the relevant fields out of the Intent that is received in #onReceive(Context,Intent) onReceive(Context,Intent), and calls hook methods with the received extras.

Extend this class and override one or more of the #onUpdate, #onDeleted, #onEnabled or #onDisabled methods to implement your own AppWidget functionality.

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

For more information about how to write an app widget provider, read the App Widgets developer guide.

</div>

Java documentation for android.appwidget.AppWidgetProvider.

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

AppWidgetProvider()	Constructor to initialize AppWidgetProvider.
AppWidgetProvider(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

AbortBroadcast	Returns the flag indicating whether or not this receiver should abort the current broadcast. (Inherited from BroadcastReceiver)
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()`. (Inherited from BroadcastReceiver)
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. (Inherited from BroadcastReceiver)
IsOrderedBroadcast	Returns true if the receiver is currently processing an ordered broadcast. (Inherited from BroadcastReceiver)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(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`. (Inherited from BroadcastReceiver)
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`. (Inherited from BroadcastReceiver)
SentFromPackage	Returns the package name of the app that initially sent this broadcast. (Inherited from BroadcastReceiver)
SentFromUid	Returns the uid of the app that initially sent this broadcast. (Inherited from BroadcastReceiver)
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

ClearAbortBroadcast()	Clears the flag indicating that this receiver should abort the current broadcast. (Inherited from BroadcastReceiver)
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
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. (Inherited from BroadcastReceiver)
GoAsync()	This can be called by an application in `#onReceive` to allow it to keep the broadcast active after returning from that function. (Inherited from BroadcastReceiver)
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`. (Inherited from BroadcastReceiver)
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)
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)
OnAppWidgetOptionsChanged(Context, AppWidgetManager, Int32, Bundle)	Called in response to the `AppWidgetManager#ACTION_APPWIDGET_OPTIONS_CHANGED` broadcast when this widget has been layed out at a new size or its options changed via `AppWidgetManager#updateAppWidgetOptions`.
OnDeleted(Context, Int32[])	Called in response to the `AppWidgetManager#ACTION_APPWIDGET_DELETED` broadcast when one or more AppWidget instances have been deleted.
OnDisabled(Context)	Called in response to the `AppWidgetManager#ACTION_APPWIDGET_DISABLED` broadcast, which is sent when the last AppWidget instance for this provider is deleted.
OnEnabled(Context)	Called in response to the `AppWidgetManager#ACTION_APPWIDGET_ENABLED` broadcast when the a AppWidget for this provider is instantiated.
OnReceive(Context, Intent)	Implements `BroadcastReceiver#onReceive` to dispatch calls to the various other methods on AppWidgetProvider.
OnRestored(Context, Int32[], Int32[])	Called in response to the `AppWidgetManager#ACTION_APPWIDGET_RESTORED` broadcast when instances of this AppWidget provider have been restored from backup.
OnUpdate(Context, AppWidgetManager, Int32[])	Called in response to the `AppWidgetManager#ACTION_APPWIDGET_UPDATE` and `AppWidgetManager#ACTION_APPWIDGET_RESTORED` broadcasts when this AppWidget provider is being asked to provide `android.widget.RemoteViews RemoteViews` for a set of AppWidgets.
PeekService(Context, Intent)	Provide a binder to an already-bound service. (Inherited from BroadcastReceiver)
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. (Inherited from BroadcastReceiver)
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`. (Inherited from BroadcastReceiver)
SetResultExtras(Bundle)	Change the current result extras of this broadcast; only works with broadcasts sent through `Context#sendOrderedBroadcast(Intent, String) Context.sendOrderedBroadcast`. (Inherited from BroadcastReceiver)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(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

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to

Share via