For more information about creating app widgets, read the * App Widgets developer guide.
** You must supply the following extras: *
| {@link #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: *
| {@link #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 * {@link 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 {@link android.app.Activity#RESULT_CANCELED} is returned, you should delete * the appWidgetId. * * @see #ACTION_APPWIDGET_CONFIGURE */ public static final String ACTION_APPWIDGET_PICK = "android.appwidget.action.APPWIDGET_PICK"; /** * Similar to ACTION_APPWIDGET_PICK, but used from keyguard * @hide */ public static final String ACTION_KEYGUARD_APPWIDGET_PICK = "android.appwidget.action.KEYGUARD_APPWIDGET_PICK"; /** * Send this from your {@link AppWidgetHost} activity when you want to bind an AppWidget to * display and bindAppWidgetIdIfAllowed returns false. *
* You must supply the following extras: *
| {@link #EXTRA_APPWIDGET_ID} | *A newly allocated appWidgetId, which will be bound to the AppWidget provider * you provide. | *
| {@link #EXTRA_APPWIDGET_PROVIDER} | *The BroadcastReceiver that will be the AppWidget provider for this AppWidget. * | *
* The system will respond with an onActivityResult call with the following extras in * the intent: *
| {@link #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 * {@link 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 {@link android.app.Activity#RESULT_CANCELED} is returned, you * should delete * the appWidgetId. * * @see #ACTION_APPWIDGET_CONFIGURE * */ public static final String ACTION_APPWIDGET_BIND = "android.appwidget.action.APPWIDGET_BIND"; /** * 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 {@link AppWidgetProviderInfo AppWidgetProviderInfo meta-data}. * *
* The intent will contain the following extras: *
| {@link #EXTRA_APPWIDGET_ID} | *The appWidgetId to configure. | *
If you return {@link android.app.Activity#RESULT_OK} using * {@link android.app.Activity#setResult Activity.setResult()}, the AppWidget will be added, * and you will receive an {@link #ACTION_APPWIDGET_UPDATE} broadcast for this AppWidget. * If you return {@link android.app.Activity#RESULT_CANCELED}, the host will cancel the add * and not display this AppWidget, and you will receive a {@link #ACTION_APPWIDGET_DELETED} broadcast. */ public static final String ACTION_APPWIDGET_CONFIGURE = "android.appwidget.action.APPWIDGET_CONFIGURE"; /** * An intent extra that contains one appWidgetId. *
* The value will be an int that can be retrieved like this: * {@sample frameworks/base/tests/appwidgets/AppWidgetHostTest/src/com/android/tests/appwidgethost/AppWidgetHostActivity.java getExtra_EXTRA_APPWIDGET_ID} */ public static final String EXTRA_APPWIDGET_ID = "appWidgetId"; /** * A bundle extra that contains the lower bound on the current width, in dips, of a widget instance. */ public static final String OPTION_APPWIDGET_MIN_WIDTH = "appWidgetMinWidth"; /** * A bundle extra that contains the lower bound on the current height, in dips, of a widget instance. */ public static final String OPTION_APPWIDGET_MIN_HEIGHT = "appWidgetMinHeight"; /** * A bundle extra that contains the upper bound on the current width, in dips, of a widget instance. */ public static final String OPTION_APPWIDGET_MAX_WIDTH = "appWidgetMaxWidth"; /** * A bundle extra that contains the upper bound on the current width, in dips, of a widget instance. */ public static final String OPTION_APPWIDGET_MAX_HEIGHT = "appWidgetMaxHeight"; /** * A bundle extra that hints to the AppWidgetProvider the category of host that owns this * this widget. Can have the value {@link * AppWidgetProviderInfo#WIDGET_CATEGORY_HOME_SCREEN} or {@link * AppWidgetProviderInfo#WIDGET_CATEGORY_KEYGUARD}. */ public static final String OPTION_APPWIDGET_HOST_CATEGORY = "appWidgetCategory"; /** * An intent extra which points to a bundle of extra information for a particular widget id. * In particular this bundle can contain EXTRA_APPWIDGET_WIDTH and EXTRA_APPWIDGET_HEIGHT. */ public static final String EXTRA_APPWIDGET_OPTIONS = "appWidgetOptions"; /** * An intent extra that contains multiple appWidgetIds. *
* The value will be an int array that can be retrieved like this: * {@sample frameworks/base/tests/appwidgets/AppWidgetHostTest/src/com/android/tests/appwidgethost/TestAppWidgetProvider.java getExtra_EXTRA_APPWIDGET_IDS} */ public static final String EXTRA_APPWIDGET_IDS = "appWidgetIds"; /** * An intent extra that contains the component name of a AppWidget provider. *
* The value will be an ComponentName. */ public static final String EXTRA_APPWIDGET_PROVIDER = "appWidgetProvider"; /** * An intent extra to pass to the AppWidget picker containing a {@link java.util.List} of * {@link AppWidgetProviderInfo} objects to mix in to the list of AppWidgets that are * installed. (This is how the launcher shows the search widget). */ public static final String EXTRA_CUSTOM_INFO = "customInfo"; /** * An intent extra to pass to the AppWidget picker containing a {@link java.util.List} of * {@link 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 {@link android.content.Intent} * that is returned from the picker activity. * * {@more} */ public static final String EXTRA_CUSTOM_EXTRAS = "customExtras"; /** * An intent extra to pass to the AppWidget picker which allows the picker to filter * the list based on the {@link AppWidgetProviderInfo#widgetCategory}. * * @hide */ public static final String EXTRA_CATEGORY_FILTER = "categoryFilter"; /** * An intent extra to pass to the AppWidget picker to specify whether or not to sort * the list of caller-specified extra AppWidgets along with the rest of the AppWidgets * @hide */ public static final String EXTRA_CUSTOM_SORT = "customSort"; /** * A sentiel value that the AppWidget manager will never return as a appWidgetId. */ public static final int INVALID_APPWIDGET_ID = 0; /** * 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 {@link AppWidgetProviderInfo#updatePeriodMillis update interval} * having lapsed, or the system booting. * *
* The intent will contain the following extras: *
| {@link #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. | *
* It is okay to call this method both inside an {@link #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. * * @param appWidgetIds The AppWidget instances for which to set the RemoteViews. * @param views The RemoteViews object to show. */ public void updateAppWidget(int[] appWidgetIds, RemoteViews views) { try { sService.updateAppWidgetIds(appWidgetIds, views); } catch (RemoteException e) { throw new RuntimeException("system server dead?", e); } } /** * 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. * * @see #getAppWidgetOptions(int) * * @param appWidgetId The AppWidget instances for which to set the RemoteViews. * @param options The options to associate with this widget */ public void updateAppWidgetOptions(int appWidgetId, Bundle options) { try { sService.updateAppWidgetOptions(appWidgetId, options); } catch (RemoteException e) { throw new RuntimeException("system server dead?", e); } } /** * 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. * * @see #updateAppWidgetOptions(int, Bundle) * * @param appWidgetId The AppWidget instances for which to set the RemoteViews. * @return The options associated with the given widget instance. */ public Bundle getAppWidgetOptions(int appWidgetId) { try { return sService.getAppWidgetOptions(appWidgetId); } catch (RemoteException e) { throw new RuntimeException("system server dead?", e); } } /** * 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 * {@link #partiallyUpdateAppWidget(int, RemoteViews)}. * *
* It is okay to call this method both inside an {@link #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. * * @param appWidgetId The AppWidget instance for which to set the RemoteViews. * @param views The RemoteViews object to show. */ public void updateAppWidget(int appWidgetId, RemoteViews views) { updateAppWidget(new int[] { appWidgetId }, views); } /** * Perform an incremental update or command on the widget(s) specified by appWidgetIds. * * This update differs from {@link #updateAppWidget(int[], 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 {@link RemoteViews#showNext(int)}, {@link RemoteViews#showPrevious(int)}, * {@link RemoteViews#setScrollPosition(int, int)} and similar commands. * *
* It is okay to call this method both inside an {@link #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 * {@link #updateAppWidget(int[], RemoteViews)}. * * @param appWidgetIds The AppWidget instances for which to set the RemoteViews. * @param views The RemoteViews object containing the incremental update / command. */ public void partiallyUpdateAppWidget(int[] appWidgetIds, RemoteViews views) { try { sService.partiallyUpdateAppWidgetIds(appWidgetIds, views); } catch (RemoteException e) { throw new RuntimeException("system server dead?", e); } } /** * Perform an incremental update or command on the widget specified by appWidgetId. * * This update differs from {@link #updateAppWidget(int, 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 {@link RemoteViews#showNext(int)}, {@link RemoteViews#showPrevious(int)}, * {@link RemoteViews#setScrollPosition(int, int)} and similar commands. * *
* It is okay to call this method both inside an {@link #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 * {@link #updateAppWidget(int[], RemoteViews)}. * * @param appWidgetId The AppWidget instance for which to set the RemoteViews. * @param views The RemoteViews object containing the incremental update / command. */ public void partiallyUpdateAppWidget(int appWidgetId, RemoteViews views) { partiallyUpdateAppWidget(new int[] { appWidgetId }, views); } /** * Set the RemoteViews to use for all AppWidget instances for the supplied AppWidget provider. * *
* It is okay to call this method both inside an {@link #ACTION_APPWIDGET_UPDATE} broadcast,
* and outside of the handler.
* This method will only work when called from the uid that owns the AppWidget provider.
*
* @param provider The {@link ComponentName} for the {@link
* android.content.BroadcastReceiver BroadcastReceiver} provider
* for your AppWidget.
* @param views The RemoteViews object to show.
*/
public void updateAppWidget(ComponentName provider, RemoteViews views) {
try {
sService.updateAppWidgetProvider(provider, views);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Notifies the specified collection view in all the specified AppWidget instances
* to invalidate their currently data.
*
* @param appWidgetIds The AppWidget instances for which to notify of view data changes.
* @param viewId The collection view id.
*/
public void notifyAppWidgetViewDataChanged(int[] appWidgetIds, int viewId) {
try {
sService.notifyAppWidgetViewDataChanged(appWidgetIds, viewId);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Notifies the specified collection view in all the specified AppWidget instance
* to invalidate it's currently data.
*
* @param appWidgetId The AppWidget instance for which to notify of view data changes.
* @param viewId The collection view id.
*/
public void notifyAppWidgetViewDataChanged(int appWidgetId, int viewId) {
notifyAppWidgetViewDataChanged(new int[] { appWidgetId }, viewId);
}
/**
* Return a list of the AppWidget providers that are currently installed.
*/
public List You need the BIND_APPWIDGET permission or the user must have enabled binding
* widgets always for your component. This method is used by the AppWidget picker and
* should not be used by other apps.
*
* @param appWidgetId The AppWidget instance for which to set the RemoteViews.
* @param provider The {@link android.content.BroadcastReceiver} that will be the AppWidget
* provider for this AppWidget.
* @hide
*/
public void bindAppWidgetId(int appWidgetId, ComponentName provider) {
try {
sService.bindAppWidgetId(appWidgetId, provider, null);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Set the component for a given appWidgetId.
*
* You need the BIND_APPWIDGET permission or the user must have enabled binding
* widgets always for your component. This method is used by the AppWidget picker and
* should not be used by other apps.
*
* @param appWidgetId The AppWidget instance for which to set the RemoteViews.
* @param provider The {@link android.content.BroadcastReceiver} that will be the AppWidget
* provider for this AppWidget.
* @param options Bundle containing options for the AppWidget. See also
* {@link #updateAppWidgetOptions(int, Bundle)}
*
* @hide
*/
public void bindAppWidgetId(int appWidgetId, ComponentName provider, Bundle options) {
try {
sService.bindAppWidgetId(appWidgetId, provider, options);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Set the component for a given appWidgetId.
*
* 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 {@link #ACTION_APPWIDGET_BIND} to request permission to
* bind
*
* @param appWidgetId The AppWidget instance for which to set the RemoteViews.
* @param provider The {@link android.content.BroadcastReceiver} that will be the AppWidget
* provider for this AppWidget.
* @return true if this component has permission to bind the AppWidget
*/
public boolean bindAppWidgetIdIfAllowed(int appWidgetId, ComponentName provider) {
if (mContext == null) {
return false;
}
try {
return sService.bindAppWidgetIdIfAllowed(
mContext.getPackageName(), appWidgetId, provider, null);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Set the component for a given appWidgetId.
*
* 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 {@link #ACTION_APPWIDGET_BIND} to request permission to
* bind
*
* @param appWidgetId The AppWidget instance for which to set the RemoteViews.
* @param provider The {@link android.content.BroadcastReceiver} that will be the AppWidget
* provider for this AppWidget.
* @param options Bundle containing options for the AppWidget. See also
* {@link #updateAppWidgetOptions(int, Bundle)}
*
* @return true if this component has permission to bind the AppWidget
*/
public boolean bindAppWidgetIdIfAllowed(int appWidgetId, ComponentName provider,
Bundle options) {
if (mContext == null) {
return false;
}
try {
return sService.bindAppWidgetIdIfAllowed(
mContext.getPackageName(), appWidgetId, provider, options);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Query if a given package was granted permission by the user to bind app widgets
*
* You need the MODIFY_APPWIDGET_BIND_PERMISSIONS permission
*
* @param packageName The package for which the permission is being queried
* @return true if the package was granted permission by the user to bind app widgets
* @hide
*/
public boolean hasBindAppWidgetPermission(String packageName) {
try {
return sService.hasBindAppWidgetPermission(packageName);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Changes any user-granted permission for the given package to bind app widgets
*
* You need the MODIFY_APPWIDGET_BIND_PERMISSIONS permission
*
* @param provider The package whose permission is being changed
* @param permission Whether to give the package permission to bind widgets
* @hide
*/
public void setBindAppWidgetPermission(String packageName, boolean permission) {
try {
sService.setBindAppWidgetPermission(packageName, permission);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Binds the RemoteViewsService for a given appWidgetId and intent.
*
* The appWidgetId specified must already be bound to the calling AppWidgetHost via
* {@link android.appwidget.AppWidgetManager#bindAppWidgetId AppWidgetManager.bindAppWidgetId()}.
*
* @param appWidgetId The AppWidget instance for which to bind the RemoteViewsService.
* @param intent The intent of the service which will be providing the data to the
* RemoteViewsAdapter.
* @param connection The callback interface to be notified when a connection is made or lost.
* @hide
*/
public void bindRemoteViewsService(int appWidgetId, Intent intent, IBinder connection) {
try {
sService.bindRemoteViewsService(appWidgetId, intent, connection);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Unbinds the RemoteViewsService for a given appWidgetId and intent.
*
* The appWidgetId specified muse already be bound to the calling AppWidgetHost via
* {@link android.appwidget.AppWidgetManager#bindAppWidgetId AppWidgetManager.bindAppWidgetId()}.
*
* @param appWidgetId The AppWidget instance for which to bind the RemoteViewsService.
* @param intent The intent of the service which will be providing the data to the
* RemoteViewsAdapter.
* @hide
*/
public void unbindRemoteViewsService(int appWidgetId, Intent intent) {
try {
sService.unbindRemoteViewsService(appWidgetId, intent);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
/**
* Get the list of appWidgetIds that have been bound to the given AppWidget
* provider.
*
* @param provider The {@link android.content.BroadcastReceiver} that is the
* AppWidget provider to find appWidgetIds for.
*/
public int[] getAppWidgetIds(ComponentName provider) {
try {
return sService.getAppWidgetIds(provider);
}
catch (RemoteException e) {
throw new RuntimeException("system server dead?", e);
}
}
}