Share via


AppWidgetProviderInfo Class

Definition

Describes the meta data for an installed AppWidget provider.

[Android.Runtime.Register("android/appwidget/AppWidgetProviderInfo", DoNotGenerateAcw=true)]
public class AppWidgetProviderInfo : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/appwidget/AppWidgetProviderInfo", DoNotGenerateAcw=true)>]
type AppWidgetProviderInfo = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Inheritance
AppWidgetProviderInfo
Attributes
Implements

Remarks

Describes the meta data for an installed AppWidget provider. The fields in this class correspond to the fields in the &lt;appwidget-provider&gt; xml tag.

Java documentation for android.appwidget.AppWidgetProviderInfo.

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

AppWidgetProviderInfo()

Unflatten the AppWidgetProviderInfo from a parcel.

AppWidgetProviderInfo(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

AppWidgetProviderInfo(Parcel)

Unflatten the AppWidgetProviderInfo from a parcel.

Fields

WidgetCategoryHomeScreen
Obsolete.

Indicates that the widget can be displayed on the home screen.

WidgetCategoryKeyguard
Obsolete.

Indicates that the widget can be displayed on the keyguard.

WidgetCategorySearchbox
Obsolete.

Indicates that the widget can be displayed within a space reserved for the search box.

WidgetFeatureConfigurationOptional
Obsolete.

The widget provides a default configuration.

WidgetFeatureHideFromPicker
Obsolete.

The widget is added directly by the app, and the host may hide this widget when providing the user with the list of available widgets to choose from.

WidgetFeatureReconfigurable
Obsolete.

The widget can be reconfigured anytime after it is bound by starting the #configure activity.

Properties

ActivityInfo

Returns the broadcast receiver that is providing this widget.

AutoAdvanceViewId

The view id of the AppWidget subview which should be auto-advanced by the widget's host.

Class

Returns the runtime class of this Object.

(Inherited from Object)
Configure

The activity to launch that will configure the AppWidget.

Creator

Parcelable.

DescriptionRes

Resource id for the description of the AppWidget.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
Icon

The icon to display for this AppWidget in the AppWidget picker.

InitialKeyguardLayout

The resource id of the initial layout for this AppWidget when it is displayed on keyguard.

InitialLayout

The resource id of the initial layout for this AppWidget.

JniIdentityHashCode (Inherited from Object)
JniPeerMembers
Label
Obsolete.

The label to display to the user in the AppWidget picker.

MaxResizeHeight

Maximum height (in px) which the widget can be resized to.

MaxResizeWidth

Maximum width (in px) which the widget can be resized to.

MinHeight

The default height of the widget when added to a host, in px.

MinResizeHeight

Minimum height (in px) which the widget can be resized to.

MinResizeWidth

Minimum width (in px) which the widget can be resized to.

MinWidth

The default width of the widget when added to a host, in px.

PeerReference (Inherited from Object)
PreviewImage

A preview of what the AppWidget will look like after it's configured.

PreviewLayout

The layout resource id of a preview of what the AppWidget will look like after it's configured.

Profile

Gets the user profile in which the provider resides.

Provider

Identity of this AppWidget component.

ResizeMode

The rules by which a widget can be resized.

TargetCellHeight

The default height of a widget when added to a host, in units of launcher grid cells.

TargetCellWidth

The default width of a widget when added to a host, in units of launcher grid cells.

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.

UpdatePeriodMillis

How often, in milliseconds, that this AppWidget wants to be updated.

WidgetCategory

Determines whether this widget can be displayed on the home screen, the keyguard, or both.

WidgetFeatures

Methods

Clone()

Creates and returns a copy of this Object.

DescribeContents()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

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)
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)
LoadDescription(Context)

Loads localized description for the app widget.

LoadDescriptionFormatted(Context)

Loads localized description for the app widget.

LoadIcon(Context, Int32)

Loads the icon to display for this AppWidget in the AppWidget picker.

LoadLabel(PackageManager)

Loads the localized label to display to the user in the AppWidget picker.

LoadPreviewImage(Context, Int32)

Loads a preview of what the AppWidget will look like after it's configured.

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)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
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)
WriteToParcel(Parcel, ParcelableWriteFlags)

Flatten this object in to a Parcel.

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