GlanceAppWidgetManager

fun getAppWidgetId(glanceId: GlanceId): Int

Retrieve the platform AppWidget ID from the provided GlanceId

Important: Do NOT use appwidget ID as identifier, instead create your own and store them in the GlanceStateDefinition. This method should only be used for compatibility or IPC communication reasons in conjunction with getGlanceIdBy

suspend fun getAppWidgetSizes(glanceId: GlanceId): List<DpSize>

Retrieve the sizes for a given App Widget, if provided by the host.

The list of sizes will be extracted from the App Widget options bundle, using the content of AppWidgetManager.OPTION_APPWIDGET_SIZES if provided. If not, and if AppWidgetManager.OPTION_APPWIDGET_MIN_HEIGHT and similar are provided, the landscape and portrait sizes will be estimated from those and returned. Otherwise, the list will contain DpSize.Zero only.

fun getGlanceIdBy(appWidgetId: Int): GlanceId

Retrieve the GlanceId of the provided AppWidget ID.

fun getGlanceIdBy(configurationIntent: Intent): GlanceId?

Retrieve the GlanceId from the configuration activity intent or null if not valid

suspend fun <T : GlanceAppWidget> getGlanceIds(provider: Class<T>): List<GlanceId>

Returns the GlanceId of the App Widgets installed for a particular provider.

suspend fun <T : GlanceAppWidgetReceiver> requestPinGlanceAppWidget(
    receiver: Class<T>,
    preview: GlanceAppWidget? = null,
    previewState: Any? = null,
    successCallback: PendingIntent? = null
): Boolean

Request to pin the GlanceAppWidget of the given receiver on the current launcher (if supported).

Note: the request is only supported for SDK 26 and beyond, for lower versions this method will be no-op and return false.

suspend fun <T : GlanceAppWidgetReceiver> requestPinGlanceAppWidget(
    receiver: Class<T>,
    preview: GlanceAppWidget? = null,
    previewSize: DpSize? = null,
    previewState: Any? = null,
    successCallback: PendingIntent? = null
): Boolean

Request to pin the GlanceAppWidget of the given receiver on the current launcher (if supported).

Note: the request is only supported for SDK 26 and beyond, for lower versions this method will be no-op and return false.

@RequiresApi(value = 35)
suspend fun setWidgetPreviews(
    receiver: KClass<GlanceAppWidgetReceiver>,
    widgetCategories: IntSet = intSetOf(
                WIDGET_CATEGORY_HOME_SCREEN or WIDGET_CATEGORY_KEYGUARD or WIDGET_CATEGORY_SEARCHBOX
            )
): Boolean

Generate and publish the widget previews for receiver for the given set of widgetCategories. Previews are generated from the layout provided by GlanceAppWidget.providePreview on the widget connected to the given receiver.

Previews should be published during the initial setup phase or launch of your app. To avoid running this unnecessarily, you can see what previews are currently published for your provider by checking AppWidgetProviderInfo.generatedPreviewCategories.

The preview composition is run for each value in the widgetCategories array. By default, a single preview is generated for all widget categories, i.e. widgetsCategories = intSetOf(WIDGET_CATEGORY_HOME_SCREEN or WIDGET_CATEGORY_KEYGUARD or WIDGET_CATEGORY_SEARCHBOX). To generate a separate preview for each widget category, pass each category as a separate item in the int set, e.g. intSetOf(WIDGET_CATEGORY_HOME_SCREEN, WIDGET_CATEGORY_KEYGUARD). This is only necessary if you want to generate different layouts for the different categories.

Note that this API is only available on Build.VERSION_CODES.VANILLA_ICE_CREAM and above, so you will likely want to set AppWidgetProviderInfo.previewLayout and AppWidgetProviderInfo.previewImage as well to have the most coverage across versions.

See also AppWidgetProviderInfo.generatedPreviewCategories, AppWidgetManager.setWidgetPreview, AppWidgetManager.getWidgetPreview, and AppWidgetManager.removeWidgetPreview.

@RequiresApi(value = 35)
suspend inline fun <T : GlanceAppWidgetReceiver> GlanceAppWidgetManager.setWidgetPreviews(
    widgetCategories: IntSet = intSetOf(
            WIDGET_CATEGORY_HOME_SCREEN or WIDGET_CATEGORY_KEYGUARD or WIDGET_CATEGORY_SEARCHBOX
        )
): Boolean

Generate and publish the widget previews for a GlanceAppWidgetReceiver for the given set of widgetCategories. Previews are generated from the layout provided by GlanceAppWidget.providePreview on the widget connected to the given GlanceAppWidgetReceiver class. This receiver must be registered as an app widget provider in the application manifest.

Previews should be published during the initial setup phase or launch of your app. To avoid running this unnecessarily, you can see what previews are currently published for your provider by checking AppWidgetProviderInfo.generatedPreviewCategories.

The preview composition is run for each value in the widgetCategories array. If your widget has the same layout across categories, you can combine all of the categories in a single value, e.g. WIDGET_CATEGORY_HOME_SCREEN or WIDGET_CATEGORY_KEYGUARD or WIDGET_CATEGORY_SEARCHBOX, which will call composeForPreview once and set the previews for all of the categories.

Note that this API is only available on Build.VERSION_CODES.VANILLA_ICE_CREAM and above, so you will likely want to set AppWidgetProviderInfo.previewLayout and AppWidgetProviderInfo.previewImage as well to have the most coverage across versions.

See also AppWidgetProviderInfo.generatedPreviewCategories, AppWidgetManager.setWidgetPreview, AppWidgetManager.getWidgetPreview, and AppWidgetManager.removeWidgetPreview.