Added in API level 3

AppWidgetManager

open class AppWidgetManager
kotlin.Any
   ↳ android.appwidget.AppWidgetManager

Updates AppWidget state; gets information about installed AppWidget providers and other AppWidget related state.


Requires the PackageManager#FEATURE_APP_WIDGETS feature which can be detected using PackageManager.hasSystemFeature(String).

Summary

Constants
static String

Activity action to launch from your AppWidgetHost activity when you want to bind an AppWidget to display and bindAppWidgetIdIfAllowed returns false.
static String

Sent when it is time to configure your AppWidget while it is being added to a host.
static String

Sent when an instance of an AppWidget is deleted from its host.
static String

Sent when the last AppWidget of this provider is removed from the last host.
static String

Sent when an instance of an AppWidget is added to a host for the first time.
static String

Sent to widget hosts after AppWidget state related to the host has been restored from backup.
static String

Sent when the custom extras for an AppWidget change.
static String

Activity action to launch from your AppWidgetHost activity when you want to pick an AppWidget to display.
static String

Sent to an AppWidgetProvider after AppWidget state related to that provider has been restored from backup.
static String

Sent when it is time to update your AppWidget.
static String

An intent extra (int) that contains one appWidgetId.
static String

An intent extra that contains multiple appWidgetIds.
static String

An intent extra that contains multiple appWidgetIds.
static String

An intent extra which points to a bundle of extra information for a particular widget id.
static String

An extra that can be passed to requestPinAppWidget(android.content.ComponentName,android.os.Bundle,android.app.PendingIntent).
static String

An intent extra that contains the component name of a AppWidget provider.
static String

An intent extra that contains the user handle of the profile under which an AppWidget provider is registered.
static String

An intent extra to pass to the AppWidget picker containing a java.util.List of android.os.Bundle objects to mix in to the list of AppWidgets that are installed.
static String

An intent extra to pass to the AppWidget picker containing a java.util.List of AppWidgetProviderInfo objects to mix in to the list of AppWidgets that are installed.
static String

An intent extra attached to the ACTION_APPWIDGET_HOST_RESTORED broadcast, indicating the integer ID of the host whose widgets have just been restored.
static Int

A sentinel value that the AppWidget manager will never return as a appWidgetId.
static String

Field for the manifest meta-data tag.
static String

A bundle extra that hints to the AppWidgetProvider the category of host that owns this this widget.
static String

A bundle extra (int) that contains the upper bound on the current width, in dips, of a widget instance.
static String

A bundle extra (int) that contains the upper bound on the current width, in dips, of a widget instance.
static String

A bundle extra (int) that contains the lower bound on the current height, in dips, of a widget instance.
static String

A bundle extra (int) that contains the lower bound on the current width, in dips, of a widget instance.
static String

A bundle extra (boolean) that contains whether or not an app has finished restoring a widget.
static String

A bundle extra (List<SizeF>) that contains the list of possible sizes, in dips, a widget instance can take.
Public methods
open Boolean
bindAppWidgetIdIfAllowed(appWidgetId: Int, provider: ComponentName!)

Set the component for a given appWidgetId.
open Boolean
bindAppWidgetIdIfAllowed(appWidgetId: Int, provider: ComponentName!, options: Bundle!)

Set the component for a given appWidgetId.
open Boolean
bindAppWidgetIdIfAllowed(appWidgetId: Int, user: UserHandle!, provider: ComponentName!, options: Bundle!)

Set the provider for a given appWidgetId if the caller has a permission.
open IntArray!

Get the list of appWidgetIds that have been bound to the given AppWidget provider.
open AppWidgetProviderInfo!
getAppWidgetInfo(appWidgetId: Int)

Get the available info about the AppWidget.
open Bundle!
getAppWidgetOptions(appWidgetId: Int)

Get the extras associated with a given widget instance.
open MutableList<AppWidgetProviderInfo!>!

Return a list of the AppWidget providers that are currently installed.
open MutableList<AppWidgetProviderInfo!>

Gets the AppWidget providers for the given package and user profile.
open MutableList<AppWidgetProviderInfo!>

Gets the AppWidget providers for the given user profile.
open static AppWidgetManager!
getInstance(context: Context!)

Get the AppWidgetManager instance to use for the supplied Context object.
open RemoteViews?
getWidgetPreview(provider: ComponentName, profile: UserHandle?, widgetCategory: Int)

Get the RemoteViews previews for this widget.
open Boolean

Return TRUE if the default launcher supports requestPinAppWidget(android.content.ComponentName,android.os.Bundle,android.app.PendingIntent)
open Unit
notifyAppWidgetViewDataChanged(appWidgetIds: IntArray!, viewId: Int)

Notifies the specified collection view in all the specified AppWidget instances to invalidate their data.
open Unit
notifyAppWidgetViewDataChanged(appWidgetId: Int, viewId: Int)

Notifies the specified collection view in the specified AppWidget instance to invalidate its data.
open Unit
partiallyUpdateAppWidget(appWidgetIds: IntArray!, views: RemoteViews!)

Perform an incremental update or command on the widget(s) specified by appWidgetIds.
open Unit
partiallyUpdateAppWidget(appWidgetId: Int, views: RemoteViews!)

Perform an incremental update or command on the widget specified by appWidgetId.
open Unit
removeWidgetPreview(provider: ComponentName, widgetCategories: Int)

Remove this provider's preview for the specified widget categories.
open Boolean
requestPinAppWidget(provider: ComponentName, extras: Bundle?, successCallback: PendingIntent?)

Request to pin an app widget on the current launcher.
open Boolean
setWidgetPreview(provider: ComponentName, widgetCategories: Int, preview: RemoteViews)

Set a preview for this widget.
open Unit
updateAppWidget(appWidgetIds: IntArray!, views: RemoteViews!)

Set the RemoteViews to use for the specified appWidgetIds.
open Unit
updateAppWidget(appWidgetId: Int, views: RemoteViews!)

Set the RemoteViews to use for the specified appWidgetId.
open Unit

Set the RemoteViews to use for all AppWidget instances for the supplied AppWidget provider.
open Unit
updateAppWidgetOptions(appWidgetId: Int, options: Bundle!)

Update the extras for a given widget instance.
open Unit
updateAppWidgetProviderInfo(provider: ComponentName!, metaDataKey: String?)

Updates the info for the supplied AppWidget provider.

Constants

ACTION_APPWIDGET_BIND

Added in API level 16
static val ACTION_APPWIDGET_BIND: String

Activity action to launch from your AppWidgetHost activity when you want to bind an AppWidget to display and bindAppWidgetIdIfAllowed returns false.

You must supply the following extras:

EXTRA_APPWIDGET_ID A newly allocated appWidgetId, which will be bound to the AppWidget provider you provide.
EXTRA_APPWIDGET_PROVIDER The BroadcastReceiver that will be the AppWidget provider for this AppWidget.
EXTRA_APPWIDGET_PROVIDER_PROFILE An optional handle to a user profile under which runs the provider for this AppWidget.

The system will respond with an onActivityResult call with the following extras in the intent:

EXTRA_APPWIDGET_ID The appWidgetId that you supplied in the original intent.

When you receive the result from the AppWidget bind activity, if the resultCode is android.app.Activity#RESULT_OK, the AppWidget has been bound. You should then check the AppWidgetProviderInfo for the returned AppWidget, and if it has one, launch its configuration activity. If android.app.Activity#RESULT_CANCELED is returned, you should delete the appWidgetId.

Value: "android.appwidget.action.APPWIDGET_BIND"

ACTION_APPWIDGET_CONFIGURE

Added in API level 3
static val ACTION_APPWIDGET_CONFIGURE: String

Sent when it is time to configure your AppWidget while it is being added to a host. This action is not sent as a broadcast to the AppWidget provider, but as a startActivity to the activity specified in the meta-data.

The intent will contain the following extras:

EXTRA_APPWIDGET_ID The appWidgetId to configure.

If you return android.app.Activity#RESULT_OK using android.app.Activity#setResult, the AppWidget will be added, and you will receive an ACTION_APPWIDGET_UPDATE broadcast for this AppWidget. If you return android.app.Activity#RESULT_CANCELED, the host will cancel the add and not display this AppWidget, and you will receive a ACTION_APPWIDGET_DELETED broadcast.

Value: "android.appwidget.action.APPWIDGET_CONFIGURE"

ACTION_APPWIDGET_DELETED

Added in API level 3
static val ACTION_APPWIDGET_DELETED: String

Sent when an instance of an AppWidget is deleted from its host.

This is a protected intent that can only be sent by the system.

Value: "android.appwidget.action.APPWIDGET_DELETED"

ACTION_APPWIDGET_DISABLED

Added in API level 3
static val ACTION_APPWIDGET_DISABLED: String

Sent when the last AppWidget of this provider is removed from the last host.

This is a protected intent that can only be sent by the system.

Value: "android.appwidget.action.APPWIDGET_DISABLED"

ACTION_APPWIDGET_ENABLED

Added in API level 3
static val ACTION_APPWIDGET_ENABLED: String

Sent when an instance of an AppWidget is added to a host for the first time. This broadcast is sent at boot time if there is a AppWidgetHost installed with an instance for this provider.

This is a protected intent that can only be sent by the system.

Value: "android.appwidget.action.APPWIDGET_ENABLED"

ACTION_APPWIDGET_HOST_RESTORED

Added in API level 21
static val ACTION_APPWIDGET_HOST_RESTORED: String

Sent to widget hosts after AppWidget state related to the host has been restored from backup. The intent contains information about how to translate AppWidget ids from the restored data to their new equivalents. If an application maintains multiple separate widget host instances, it will receive this broadcast separately for each one.

The intent will contain the following extras:

EXTRA_APPWIDGET_OLD_IDS The set of appWidgetIds represented in a restored backup that have been successfully incorporated into the current environment. This may be all of the AppWidgets known to this application, or just a subset. Each entry in this array of appWidgetIds has a corresponding entry in the EXTRA_APPWIDGET_IDS extra.
EXTRA_APPWIDGET_IDS The set of appWidgetIds now valid for this application. The app should look at its restored widget configuration and translate each appWidgetId in the EXTRA_APPWIDGET_OLD_IDS array to its new value found at the corresponding index within this array.
EXTRA_HOST_ID The integer ID of the widget host instance whose state has just been restored.

This is a protected intent that can only be sent by the system.

Value: "android.appwidget.action.APPWIDGET_HOST_RESTORED"

ACTION_APPWIDGET_OPTIONS_CHANGED

Added in API level 16
static val ACTION_APPWIDGET_OPTIONS_CHANGED: String

Sent when the custom extras for an AppWidget change.

This is a protected intent that can only be sent by the system.

Value: "android.appwidget.action.APPWIDGET_UPDATE_OPTIONS"

ACTION_APPWIDGET_PICK

Added in API level 3
static val ACTION_APPWIDGET_PICK: String

Activity action to launch from your AppWidgetHost activity when you want to pick an AppWidget to display. The AppWidget picker activity will be launched.

You must supply the following extras:

EXTRA_APPWIDGET_ID A newly allocated appWidgetId, which will be bound to the AppWidget provider once the user has selected one.

The system will respond with an onActivityResult call with the following extras in the intent:

EXTRA_APPWIDGET_ID The appWidgetId that you supplied in the original intent.

When you receive the result from the AppWidget pick activity, if the resultCode is android.app.Activity#RESULT_OK, an AppWidget has been selected. You should then check the AppWidgetProviderInfo for the returned AppWidget, and if it has one, launch its configuration activity. If android.app.Activity#RESULT_CANCELED is returned, you should delete the appWidgetId.

Value: "android.appwidget.action.APPWIDGET_PICK"

ACTION_APPWIDGET_RESTORED

Added in API level 21
static val ACTION_APPWIDGET_RESTORED: String

Sent to an AppWidgetProvider after AppWidget state related to that provider has been restored from backup. The intent contains information about how to translate AppWidget ids from the restored data to their new equivalents.

The intent will contain the following extras:

EXTRA_APPWIDGET_OLD_IDS The set of appWidgetIds represented in a restored backup that have been successfully incorporated into the current environment. This may be all of the AppWidgets known to this application, or just a subset. Each entry in this array of appWidgetIds has a corresponding entry in the EXTRA_APPWIDGET_IDS extra.
EXTRA_APPWIDGET_IDS The set of appWidgetIds now valid for this application. The app should look at its restored widget configuration and translate each appWidgetId in the EXTRA_APPWIDGET_OLD_IDS array to its new value found at the corresponding index within this array.

This is a protected intent that can only be sent by the system.

Value: "android.appwidget.action.APPWIDGET_RESTORED"

ACTION_APPWIDGET_UPDATE

Added in API level 3
static val ACTION_APPWIDGET_UPDATE: String

Sent when it is time to update your AppWidget.

This may be sent in response to a new instance for this AppWidget provider having been instantiated, the requested update interval having lapsed, or the system booting.

The intent will contain the following extras:

EXTRA_APPWIDGET_IDS The appWidgetIds to update. This may be all of the AppWidgets created for this provider, or just a subset. The system tries to send updates for as few AppWidget instances as possible. 
Value: "android.appwidget.action.APPWIDGET_UPDATE"

EXTRA_APPWIDGET_ID

Added in API level 3
static val EXTRA_APPWIDGET_ID: String

An intent extra (int) that contains one appWidgetId.

The value will be an int that can be retrieved like this:

Value: "appWidgetId"

EXTRA_APPWIDGET_IDS

Added in API level 3
static val EXTRA_APPWIDGET_IDS: String

An intent extra that contains multiple appWidgetIds.

The value will be an int array that can be retrieved like this:

Value: "appWidgetIds"

EXTRA_APPWIDGET_OLD_IDS

Added in API level 21
static val EXTRA_APPWIDGET_OLD_IDS: String

An intent extra that contains multiple appWidgetIds. These are id values as they were provided to the application during a recent restore from backup. It is attached to the ACTION_APPWIDGET_RESTORED broadcast intent.

The value will be an int array that can be retrieved like this:

Value: "appWidgetOldIds"

EXTRA_APPWIDGET_OPTIONS

Added in API level 16
static val EXTRA_APPWIDGET_OPTIONS: String

An intent extra which points to a bundle of extra information for a particular widget id. In particular this bundle can contain OPTION_APPWIDGET_MIN_WIDTH, OPTION_APPWIDGET_MIN_HEIGHT, OPTION_APPWIDGET_MAX_WIDTH, OPTION_APPWIDGET_MAX_HEIGHT.

Value: "appWidgetOptions"

EXTRA_APPWIDGET_PREVIEW

Added in API level 26
static val EXTRA_APPWIDGET_PREVIEW: String

An extra that can be passed to requestPinAppWidget(android.content.ComponentName,android.os.Bundle,android.app.PendingIntent). This would allow the launcher app to present a custom preview to the user.

The value should be a RemoteViews similar to what is used with #updateAppWidget calls.

Value: "appWidgetPreview"

EXTRA_APPWIDGET_PROVIDER

Added in API level 16
static val EXTRA_APPWIDGET_PROVIDER: String

An intent extra that contains the component name of a AppWidget provider.

The value will be an android.content.ComponentName.

Value: "appWidgetProvider"

EXTRA_APPWIDGET_PROVIDER_PROFILE

Added in API level 21
static val EXTRA_APPWIDGET_PROVIDER_PROFILE: String

An intent extra that contains the user handle of the profile under which an AppWidget provider is registered.

The value will be a android.os.UserHandle.

Value: "appWidgetProviderProfile"

EXTRA_CUSTOM_EXTRAS

Added in API level 3
static val EXTRA_CUSTOM_EXTRAS: String

An intent extra to pass to the AppWidget picker containing a java.util.List of android.os.Bundle objects to mix in to the list of AppWidgets that are installed. It will be added to the extras object on the android.content.Intent that is returned from the picker activity. {@more}

Value: "customExtras"

EXTRA_CUSTOM_INFO

Added in API level 3
static val EXTRA_CUSTOM_INFO: String

An intent extra to pass to the AppWidget picker containing a java.util.List of AppWidgetProviderInfo objects to mix in to the list of AppWidgets that are installed. (This is how the launcher shows the search widget).

Value: "customInfo"

EXTRA_HOST_ID

Added in API level 21
static val EXTRA_HOST_ID: String

An intent extra attached to the ACTION_APPWIDGET_HOST_RESTORED broadcast, indicating the integer ID of the host whose widgets have just been restored.

Value: "hostId"

INVALID_APPWIDGET_ID

Added in API level 3
static val INVALID_APPWIDGET_ID: Int

A sentinel value that the AppWidget manager will never return as a appWidgetId.

Value: 0

META_DATA_APPWIDGET_PROVIDER

Added in API level 3
static val META_DATA_APPWIDGET_PROVIDER: String

Field for the manifest meta-data tag.

Value: "android.appwidget.provider"

OPTION_APPWIDGET_HOST_CATEGORY

Added in API level 17
static val OPTION_APPWIDGET_HOST_CATEGORY: String

A bundle extra that hints to the AppWidgetProvider the category of host that owns this this widget. Can have the value android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_HOME_SCREEN or android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_KEYGUARD or android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_SEARCHBOX.

Value: "appWidgetCategory"

OPTION_APPWIDGET_MAX_HEIGHT

Added in API level 16
static val OPTION_APPWIDGET_MAX_HEIGHT: String

A bundle extra (int) that contains the upper bound on the current width, in dips, of a widget instance.

Value: "appWidgetMaxHeight"

OPTION_APPWIDGET_MAX_WIDTH

Added in API level 16
static val OPTION_APPWIDGET_MAX_WIDTH: String

A bundle extra (int) that contains the upper bound on the current width, in dips, of a widget instance.

Value: "appWidgetMaxWidth"

OPTION_APPWIDGET_MIN_HEIGHT

Added in API level 16
static val OPTION_APPWIDGET_MIN_HEIGHT: String

A bundle extra (int) that contains the lower bound on the current height, in dips, of a widget instance.

Value: "appWidgetMinHeight"

OPTION_APPWIDGET_MIN_WIDTH

Added in API level 16
static val OPTION_APPWIDGET_MIN_WIDTH: String

A bundle extra (int) that contains the lower bound on the current width, in dips, of a widget instance.

Value: "appWidgetMinWidth"

OPTION_APPWIDGET_RESTORE_COMPLETED

Added in API level 30
static val OPTION_APPWIDGET_RESTORE_COMPLETED: String

A bundle extra (boolean) that contains whether or not an app has finished restoring a widget.

After restore, the app should set OPTION_APPWIDGET_RESTORE_COMPLETED to true on its widgets followed by calling #updateAppWidget to update the views.

Value: "appWidgetRestoreCompleted"

OPTION_APPWIDGET_SIZES

Added in API level 31
static val OPTION_APPWIDGET_SIZES: String

A bundle extra (List<SizeF>) that contains the list of possible sizes, in dips, a widget instance can take.

Value: "appWidgetSizes"

Public methods

bindAppWidgetIdIfAllowed

Added in API level 16
open fun bindAppWidgetIdIfAllowed(
    appWidgetId: Int, 
    provider: ComponentName!
): Boolean

Set the component for a given appWidgetId. If successful, the app widget provider will receive a ACTION_APPWIDGET_UPDATE broadcast.

You need the BIND_APPWIDGET permission or the user must have enabled binding widgets always for your component. Should be used by apps that host widgets; if this method returns false, call ACTION_APPWIDGET_BIND to request permission to bind

Parameters
appWidgetId Int: The AppWidget id under which to bind the provider.
provider ComponentName!: The android.content.BroadcastReceiver that will be the AppWidget provider for this AppWidget.
Return
Boolean true if this component has permission to bind the AppWidget

bindAppWidgetIdIfAllowed

Added in API level 17
open fun bindAppWidgetIdIfAllowed(
    appWidgetId: Int, 
    provider: ComponentName!, 
    options: Bundle!
): Boolean

Set the component for a given appWidgetId. If successful, the app widget provider will receive a ACTION_APPWIDGET_UPDATE broadcast.

You need the BIND_APPWIDGET permission or the user must have enabled binding widgets always for your component. Should be used by apps that host widgets; if this method returns false, call ACTION_APPWIDGET_BIND to request permission to bind

Parameters
appWidgetId Int: The AppWidget id under which to bind the provider.
provider ComponentName!: The android.content.BroadcastReceiver that will be the AppWidget provider for this AppWidget.
options Bundle!: Bundle containing options for the AppWidget. See also updateAppWidgetOptions(int,android.os.Bundle)
Return
Boolean true if this component has permission to bind the AppWidget

bindAppWidgetIdIfAllowed

Added in API level 21
open fun bindAppWidgetIdIfAllowed(
    appWidgetId: Int, 
    user: UserHandle!, 
    provider: ComponentName!, 
    options: Bundle!
): Boolean

Set the provider for a given appWidgetId if the caller has a permission. If successful, the app widget provider will receive a ACTION_APPWIDGET_UPDATE broadcast.

Note: You need the android.Manifest.permission#BIND_APPWIDGET permission or the user must have enabled binding widgets always for your component. Should be used by apps that host widgets. If this method returns false, call ACTION_APPWIDGET_BIND to request permission to bind.

Parameters
appWidgetId Int: The AppWidget id under which to bind the provider.
user UserHandle!: The user id in which the provider resides.
provider ComponentName!: The component name of the provider.
options Bundle!: An optional Bundle containing options for the AppWidget.
Return
Boolean true if this component has permission to bind the AppWidget

getAppWidgetIds

Added in API level 3
open fun getAppWidgetIds(provider: ComponentName!): IntArray!

Get the list of appWidgetIds that have been bound to the given AppWidget provider.

Parameters
provider ComponentName!: The android.content.BroadcastReceiver that is the AppWidget provider to find appWidgetIds for.

getAppWidgetInfo

Added in API level 3
open fun getAppWidgetInfo(appWidgetId: Int): AppWidgetProviderInfo!

Get the available info about the AppWidget.

Return
AppWidgetProviderInfo! A appWidgetId. If the appWidgetId has not been bound to a provider yet, or you don't have access to that appWidgetId, null is returned.

getAppWidgetOptions

Added in API level 16
open fun getAppWidgetOptions(appWidgetId: Int): Bundle!

Get the extras associated with a given widget instance.

The extras can be used to embed additional information about this widget to be accessed by the associated widget's AppWidgetProvider.

Parameters
appWidgetId Int: The AppWidget instances for which to set the RemoteViews.
Return
Bundle! The options associated with the given widget instance.

getInstalledProviders

Added in API level 3
open fun getInstalledProviders(): MutableList<AppWidgetProviderInfo!>!

Return a list of the AppWidget providers that are currently installed.

getInstalledProvidersForPackage

Added in API level 26
open fun getInstalledProvidersForPackage(
    packageName: String, 
    profile: UserHandle?
): MutableList<AppWidgetProviderInfo!>

Gets the AppWidget providers for the given package and user profile. User profile can only be the current user or a profile of the current user. For example, the current user may have a corporate profile. In this case the parent user profile has a child profile, the corporate one.

Parameters
packageName String: The package for which to get providers. If null, this method is equivalent to getInstalledProvidersForProfile(android.os.UserHandle).
profile UserHandle?: The profile for which to get providers. Passing null is equivalent to querying for only the calling user.
Return
MutableList<AppWidgetProviderInfo!> The installed providers, or an empty list if none are found for the given package and user. This value cannot be null.
Exceptions
java.lang.NullPointerException if the provided package name is null

getInstalledProvidersForProfile

Added in API level 21
open fun getInstalledProvidersForProfile(profile: UserHandle?): MutableList<AppWidgetProviderInfo!>

Gets the AppWidget providers for the given user profile. User profile can only be the current user or a profile of the current user. For example, the current user may have a corporate profile. In this case the parent user profile has a child profile, the corporate one.

Parameters
profile UserHandle?: The profile for which to get providers. Passing null is equivalent to querying for only the calling user.
Return
MutableList<AppWidgetProviderInfo!> The installed providers, or an empty list if none are found for the given user. This value cannot be null.

getInstance

Added in API level 3
open static fun getInstance(context: Context!): AppWidgetManager!

Get the AppWidgetManager instance to use for the supplied Context object.

getWidgetPreview

Added in API level 35
open fun getWidgetPreview(
    provider: ComponentName, 
    profile: UserHandle?, 
    widgetCategory: Int
): RemoteViews?

Get the RemoteViews previews for this widget.

Parameters
provider ComponentName: The ComponentName for the BroadcastReceiver provider for the AppWidget you intend to get a preview for. This value cannot be null.
profile UserHandle?: The profile in which the provider resides. Passing null is equivalent to querying for only the calling user.
widgetCategory Int: The widget category for which you want to display previews. This should be a single category. If a combination of categories is provided, this function will return a preview that matches at least one of the categories. Value is either 0 or a combination of android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_HOME_SCREEN, android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_KEYGUARD, and android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_SEARCHBOX
Return
RemoteViews? The widget preview for the selected category, if available. This value may be null.

isRequestPinAppWidgetSupported

Added in API level 26
open fun isRequestPinAppWidgetSupported(): Boolean

Return TRUE if the default launcher supports requestPinAppWidget(android.content.ComponentName,android.os.Bundle,android.app.PendingIntent)

notifyAppWidgetViewDataChanged

Added in API level 11
Deprecated in API level 35
open fun notifyAppWidgetViewDataChanged(
    appWidgetIds: IntArray!, 
    viewId: Int
): Unit

Deprecated: The corresponding API RemoteViews#setRemoteAdapter(int, Intent) associated with this method has been deprecated. Moving forward please use RemoteViews#setRemoteAdapter(int, android.widget.RemoteViews.RemoteCollectionItems) instead to set android.widget.RemoteViews.RemoteCollectionItems for the remote adapter and update the widget views by calling updateAppWidget(int[],android.widget.RemoteViews), updateAppWidget(int,android.widget.RemoteViews), updateAppWidget(android.content.ComponentName,android.widget.RemoteViews), partiallyUpdateAppWidget(int[],android.widget.RemoteViews), or partiallyUpdateAppWidget(int,android.widget.RemoteViews), whichever applicable.

Notifies the specified collection view in all the specified AppWidget instances to invalidate their data.

Parameters
appWidgetIds IntArray!: The AppWidget instances to notify of view data changes.
viewId Int: The collection view id.

notifyAppWidgetViewDataChanged

Added in API level 11
Deprecated in API level 35
open fun notifyAppWidgetViewDataChanged(
    appWidgetId: Int, 
    viewId: Int
): Unit

Deprecated: The corresponding API RemoteViews#setRemoteAdapter(int, Intent) associated with this method has been deprecated. Moving forward please use RemoteViews#setRemoteAdapter(int, android.widget.RemoteViews.RemoteCollectionItems) instead to set android.widget.RemoteViews.RemoteCollectionItems for the remote adapter and update the widget views by calling updateAppWidget(int[],android.widget.RemoteViews), updateAppWidget(int,android.widget.RemoteViews), updateAppWidget(android.content.ComponentName,android.widget.RemoteViews), partiallyUpdateAppWidget(int[],android.widget.RemoteViews), or partiallyUpdateAppWidget(int,android.widget.RemoteViews), whichever applicable.

Notifies the specified collection view in the specified AppWidget instance to invalidate its data.

Parameters
appWidgetId Int: The AppWidget instance to notify of view data changes.
viewId Int: The collection view id.

partiallyUpdateAppWidget

Added in API level 11
open fun partiallyUpdateAppWidget(
    appWidgetIds: IntArray!, 
    views: RemoteViews!
): Unit

Perform an incremental update or command on the widget(s) specified by appWidgetIds.

This update differs from updateAppWidget(int[],android.widget.RemoteViews) in that the RemoteViews object which is passed is understood to be an incomplete representation of the widget, and hence does not replace the cached representation of the widget. As of API level 17, the new properties set within the views objects will be appended to the cached representation of the widget, and hence will persist. Use with RemoteViews#showNext(int), RemoteViews#showPrevious(int), RemoteViews#setScrollPosition(int, int) and similar commands.

It is okay to call this method both inside an ACTION_APPWIDGET_UPDATE broadcast, and outside of the handler. This method will only work when called from the uid that owns the AppWidget provider.

This method will be ignored if a widget has not received a full update via updateAppWidget(int[],android.widget.RemoteViews).

Parameters
appWidgetIds IntArray!: The AppWidget instances for which to set the RemoteViews.
views RemoteViews!: The RemoteViews object containing the incremental update / command.

partiallyUpdateAppWidget

Added in API level 11
open fun partiallyUpdateAppWidget(
    appWidgetId: Int, 
    views: RemoteViews!
): Unit

Perform an incremental update or command on the widget specified by appWidgetId.

This update differs from updateAppWidget(int,android.widget.RemoteViews) in that the RemoteViews object which is passed is understood to be an incomplete representation of the widget, and hence is not cached by the AppWidgetService. Note that because these updates are not cached, any state that they modify that is not restored by restoreInstanceState will not persist in the case that the widgets are restored using the cached version in AppWidgetService. Use with RemoteViews#showNext(int), RemoteViews#showPrevious(int), RemoteViews#setScrollPosition(int, int) and similar commands.

It is okay to call this method both inside an ACTION_APPWIDGET_UPDATE broadcast, and outside of the handler. This method will only work when called from the uid that owns the AppWidget provider.

This method will be ignored if a widget has not received a full update via updateAppWidget(int[],android.widget.RemoteViews).

Parameters
appWidgetId Int: The AppWidget instance for which to set the RemoteViews.
views RemoteViews!: The RemoteViews object containing the incremental update / command.

removeWidgetPreview

Added in API level 35
open fun removeWidgetPreview(
    provider: ComponentName, 
    widgetCategories: Int
): Unit

Remove this provider's preview for the specified widget categories. If the provider does not have a preview for the specified widget category, this is a no-op.

Parameters
provider ComponentName: The AppWidgetProvider to remove previews for. This value cannot be null.
widgetCategories Int: The categories of the preview to remove. For example, removing the preview for WIDGET_CATEGORY_HOME_SCREEN | WIDGET_CATEGORY_KEYGUARD will remove the previews for both categories. Value is either 0 or a combination of android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_HOME_SCREEN, android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_KEYGUARD, and android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_SEARCHBOX

requestPinAppWidget

Added in API level 26
open fun requestPinAppWidget(
    provider: ComponentName, 
    extras: Bundle?, 
    successCallback: PendingIntent?
): Boolean

Request to pin an app widget on the current launcher. It's up to the launcher to accept this request (optionally showing a user confirmation). If the request is accepted, the caller will get a confirmation with extra EXTRA_APPWIDGET_ID.

When a request is denied by the user, the caller app will not get any response.

Only apps with a foreground activity or a foreground service can call it. Otherwise it'll throw IllegalStateException.

It's up to the launcher how to handle previous pending requests when the same package calls this API multiple times in a row. It may ignore the previous requests, for example.

Launcher will not show the configuration activity associated with the provider in this case. The app could either show the configuration activity as a response to the callback, or show if before calling the API (various configurations can be encapsulated in successCallback to avoid persisting them before the widgetId is known).

Parameters
provider ComponentName: The ComponentName for the provider for your AppWidget. This value cannot be null.
extras Bundle?: In not null, this is passed to the launcher app. For eg EXTRA_APPWIDGET_PREVIEW can be used for a custom preview.
successCallback PendingIntent?: If not null, this intent will be sent when the widget is created.
Return
Boolean TRUE if the launcher supports this feature. Note the API will return without waiting for the user to respond, so getting TRUE from this API does *not* mean the shortcut is pinned. FALSE if the launcher doesn't support this feature or if calling app belongs to a user-profile with items restricted on home screen.
Exceptions
java.lang.IllegalStateException The caller doesn't have a foreground activity or a foreground service or when the user is locked.

setWidgetPreview

Added in API level 35
open fun setWidgetPreview(
    provider: ComponentName, 
    widgetCategories: Int, 
    preview: RemoteViews
): Boolean

Set a preview for this widget. This preview will be used instead of the provider's previewLayout or previewImage for previewing the widget in the widget picker and pin app widget flow.

Parameters
provider ComponentName: The ComponentName for the BroadcastReceiver provider for the AppWidget you intend to provide a preview for. This value cannot be null.
widgetCategories Int: The categories that this preview should be used for. This can be a single category or combination of categories. If multiple categories are specified, then this preview will be used for each of those categories. For example, if you set a preview for WIDGET_CATEGORY_HOME_SCREEN | WIDGET_CATEGORY_KEYGUARD, the preview will be used when picking widgets for the home screen and keyguard.

Note: You should only use the widget categories that the provider supports, as defined in AppWidgetProviderInfo#widgetCategory. Value is either 0 or a combination of android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_HOME_SCREEN, android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_KEYGUARD, and android.appwidget.AppWidgetProviderInfo#WIDGET_CATEGORY_SEARCHBOX
preview RemoteViews: This preview will be used for previewing the provider when picking widgets for the selected categories. This value cannot be null.
Return
Boolean true if the call was successful, false if it was rate-limited.

updateAppWidget

Added in API level 3
open fun updateAppWidget(
    appWidgetIds: IntArray!, 
    views: RemoteViews!
): Unit

Set the RemoteViews to use for the specified appWidgetIds.

Note that the RemoteViews parameter will be cached by the AppWidgetService, and hence should contain a complete representation of the widget. For performing partial widget updates, see partiallyUpdateAppWidget(int[],android.widget.RemoteViews).

It is okay to call this method both inside an ACTION_APPWIDGET_UPDATE broadcast, and outside of the handler. This method will only work when called from the uid that owns the AppWidget provider.

The total Bitmap memory used by the RemoteViews object cannot exceed that required to fill the screen 1.5 times, ie. (screen width x screen height x 4 x 1.5) bytes.

Parameters
appWidgetIds IntArray!: The AppWidget instances for which to set the RemoteViews.
views RemoteViews!: The RemoteViews object to show.

updateAppWidget

Added in API level 3
open fun updateAppWidget(
    appWidgetId: Int, 
    views: RemoteViews!
): Unit

Set the RemoteViews to use for the specified appWidgetId.

Note that the RemoteViews parameter will be cached by the AppWidgetService, and hence should contain a complete representation of the widget. For performing partial widget updates, see partiallyUpdateAppWidget(int,android.widget.RemoteViews).

It is okay to call this method both inside an ACTION_APPWIDGET_UPDATE broadcast, and outside of the handler. This method will only work when called from the uid that owns the AppWidget provider.

The total Bitmap memory used by the RemoteViews object cannot exceed that required to fill the screen 1.5 times, ie. (screen width x screen height x 4 x 1.5) bytes.

Parameters
appWidgetId Int: The AppWidget instance for which to set the RemoteViews.
views RemoteViews!: The RemoteViews object to show.

updateAppWidget

Added in API level 3
open fun updateAppWidget(
    provider: ComponentName!, 
    views: RemoteViews!
): Unit

Set the RemoteViews to use for all AppWidget instances for the supplied AppWidget provider.

It is okay to call this method both inside an ACTION_APPWIDGET_UPDATE broadcast, and outside of the handler. This method will only work when called from the uid that owns the AppWidget provider.

Parameters
provider ComponentName!: The ComponentName for the provider for your AppWidget.
views RemoteViews!: The RemoteViews object to show.

updateAppWidgetOptions

Added in API level 16
open fun updateAppWidgetOptions(
    appWidgetId: Int, 
    options: Bundle!
): Unit

Update the extras for a given widget instance.

The extras can be used to embed additional information about this widget to be accessed by the associated widget's AppWidgetProvider.

The new options are merged into existing options using android.os.Bundle#putAll semantics.

Parameters
appWidgetId Int: The AppWidget instances for which to set the RemoteViews.
options Bundle!: The options to associate with this widget

updateAppWidgetProviderInfo

Added in API level 28
open fun updateAppWidgetProviderInfo(
    provider: ComponentName!, 
    metaDataKey: String?
): Unit

Updates the info for the supplied AppWidget provider. Apps can use this to change the default behavior of the widget based on the state of the app (for e.g., if the user is logged in or not). Calling this API completely replaces the previous definition.

The manifest entry of the provider should contain an additional meta-data tag similar to META_DATA_APPWIDGET_PROVIDER which should point to any alternative definitions for the provider.

This is persisted across device reboots and app updates. If this meta-data key is not present in the manifest entry, the info reverts to default.

Parameters
provider ComponentName!: ComponentName for the provider for your AppWidget.
metaDataKey String?: key for the meta-data tag pointing to the new provider info. Use null to reset any previously set info.