Cómo compilar un host de widgets

La pantalla principal de Android, que está disponible en la mayoría de los dispositivos Android, permite al usuario incorporar widgets de apps (o widgets) para acceder rápidamente al contenido. Si estás compilando un reemplazo de la pantalla principal o una app similar, también puedes permitir que el usuario incorpore widgets implementando AppWidgetHost. Esto no es algo que la mayoría de las apps tengan que hacer, pero, si estás creando tu propio host, es importante comprender las obligaciones contractuales que un host acepta de manera implícita.

En esta página, se describen las responsabilidades involucradas en la implementación de un AppWidgetHost personalizado. Para ver un ejemplo específico de cómo implementar un AppWidgetHost, consulta el código fuente de la pantalla principal de Android LauncherAppWidgetHost.

A continuación, se incluye una descripción general de las clases y los conceptos clave relacionados con la implementación de un AppWidgetHost personalizado:

  • Host de widgets de apps: El AppWidgetHost proporciona la interacción con el servicio AppWidget para las apps que incorporan widgets en su IU. Un AppWidgetHost debe tener un ID que sea único dentro del propio paquete del host. Este ID persiste en todos los usos del host. Por lo general, el ID es un valor codificado que asignas en tu app.

  • ID del widget de la app: A cada instancia de widget se le asigna un ID único en el momento de la vinculación. Consulta bindAppWidgetIdIfAllowed() y, para obtener más detalles, la sección Vinculación de widgets a continuación. El host obtiene el ID único mediante allocateAppWidgetId(). Este ID persiste durante toda la vida útil del widget hasta que se borra del host. El paquete de hosting debe conservar cualquier estado específico del host, como el tamaño y la ubicación del widget, y asociarlo con el ID del widget de la app.

  • Vista del host del widget de la app: Considera AppWidgetHostView como un marco en el que se une el widget cada vez que es necesario que se muestre. Un widget se asocia con un AppWidgetHostView cada vez que el host lo aumenta.

    • De forma predeterminada, el sistema crea un AppWidgetHostView, pero el host puede crear su propia subclase de AppWidgetHostView si la extiende.
    • A partir de Android 12 (nivel de API 31), AppWidgetHostView presenta los métodos setColorResources() y resetColorResources() para controlar los colores sobrecargados de forma dinámica. El host es responsable de proporcionar los colores a estos métodos.

  • Paquete de opciones: El AppWidgetHost usa el paquete de opciones para comunicarle información a la AppWidgetProvider sobre cómo se muestra el widget (por ejemplo, la lista de rangos de tamaño) y si está en una pantalla de bloqueo o en la pantalla principal. Esta información permite que AppWidgetProvider adapte el contenido y la apariencia del widget en función de cómo y dónde se muestra. Puedes usar updateAppWidgetOptions() y updateAppWidgetSize() para modificar el paquete de un widget. Ambos métodos activan la devolución de llamada onAppWidgetOptionsChanged() a AppWidgetProvider.

Cómo vincular widgets

Cuando un usuario agrega un widget a un host, se produce un proceso llamado vinculación. La vinculación se refiere a asociar un ID de un widget de la app en particular con un host y un AppWidgetProvider específicos.

Las APIs de vinculación también permiten que un host proporcione una IU personalizada para la vinculación. Para usar este proceso, tu app debe declarar el permiso BIND_APPWIDGET en el manifiesto del host:

<uses-permission android:name="android.permission.BIND_APPWIDGET" />

Pero este es solo el primer paso. Durante el tiempo de ejecución, el usuario debe otorgar permiso explícito a tu app para que pueda agregar un widget al host. Si deseas probar si tu app tiene permiso para agregar el widget, usa el método bindAppWidgetIdIfAllowed(). Si bindAppWidgetIdIfAllowed() muestra false, tu app debe mostrar un diálogo en el que se le solicite al usuario otorgar permiso: "permitir" para la adición actual del widget o "permitir siempre" para cubrir todas las adiciones futuras de widgets.

En este fragmento, se proporciona un ejemplo de cómo mostrar el diálogo:

Kotlin

val intent = Intent(AppWidgetManager.ACTION_APPWIDGET_BIND).apply {
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_PROVIDER, info.componentName)
    // This is the options bundle described in the preceding section.
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_OPTIONS, options)
}
startActivityForResult(intent, REQUEST_BIND_APPWIDGET)

Java

Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_BIND);
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_PROVIDER, info.componentName);
// This is the options bundle described in the preceding section.
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_OPTIONS, options);
startActivityForResult(intent, REQUEST_BIND_APPWIDGET);

El host debe verificar si el widget que agrega un usuario necesita configuración. Para obtener más información, consulta Cómo permitir que los usuarios configuren widgets de apps.

Responsabilidades del host

Puedes especificar una serie de parámetros de configuración para los widgets mediante los metadatos AppWidgetProviderInfo. Puedes recuperar estas opciones de configuración, que se analizan con más detalle en las siguientes secciones, desde el objeto AppWidgetProviderInfo asociado con un proveedor de widgets.

Sin importar la versión de Android a la que se oriente tu app, todos los hosts tienen las siguientes responsabilidades:

  • Cuando agregues un widget, asigna su ID como se describió anteriormente. Cuando se quita un widget del host, llama a deleteAppWidgetId() para anular la asignación del ID del widget.

  • Cuando agregues un widget, verifica si debe iniciarse la actividad de configuración. Por lo general, el host debe iniciar la actividad de configuración del widget si existe y no está marcado como opcional especificando las marcas configuration_optional y reconfigurable. Para obtener más detalles, consulta Cómo actualizar el widget desde la actividad de configuración. Este es un paso necesario para que muchos widgets puedan mostrarse.

  • Los widgets especifican un ancho y una altura predeterminados en los metadatos de AppWidgetProviderInfo. Estos valores se definen en celdas (a partir de Android 12, si se especifican targetCellWidth y targetCellHeight) o en dps si solo se especifican minWidth y minHeight. Consulta Atributos de tamaño de widgets.

    Asegúrate de que el widget esté dispuesto con al menos esta cantidad de dps. Por ejemplo, muchos hosts alinean íconos y widgets en una cuadrícula. En este caso, de forma predeterminada, el host agrega un widget con la cantidad mínima de celdas que cumplen con las restricciones minWidth y minHeight.

Además de los requisitos enumerados en la sección anterior, las versiones específicas de la plataforma introducen funciones que otorgan nuevas responsabilidades al host.

Determina tu enfoque según la versión de Android de destino

Android 12

Android 12 (nivel de API 31) empaqueta un List<SizeF> adicional que contiene la lista de tamaños posibles en dps que una instancia de widget puede tomar en el paquete de opciones. La cantidad de tamaños proporcionados depende de la implementación del host. Por lo general, los hosts proporcionan dos tamaños para teléfonos (vertical y horizontal), y cuatro tamaños para dispositivos plegables.

Existe un límite de MAX_INIT_VIEW_COUNT (16) para la cantidad de RemoteViews diferentes que un AppWidgetProvider puede proporcionar a RemoteViews. Dado que los objetos AppWidgetProvider asignan un objeto RemoteViews a cada tamaño en List<SizeF>, no proporciones más de MAX_INIT_VIEW_COUNT tamaños.

En Android 12, también se introducen los atributos maxResizeWidth y maxResizeHeight en dps. Recomendamos que un widget que use al menos uno de estos atributos no supere el tamaño especificado por los atributos.

Recursos adicionales

  • Consulta la documentación de referencia de Glance.