Cómo compilar un host de widgets

La pantalla principal de Android, disponible en la mayoría de los dispositivos con Android, permite al usuario incorporar widgets de apps (o widgets) para acceder al contenido de forma rápida. 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 necesiten hacer, pero, si vas a crear tu propio host, es importante comprender las obligaciones contractuales que un host acepta de manera implícita.

El enfoque principal de esta página son las responsabilidades relacionadas con 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 la app: 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 único dentro del propio paquete del host. Este ID persiste en todos los usos del host. Por lo general, el ID es un valor hard-coded que asignas en tu app.

• ID de 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 Cómo vincular widgets que se incluye a continuación. El host obtiene el ID único con 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 de widgets de la app: Piensa en AppWidgetHostView como un marco en el que se une el widget cada vez que es necesario que aparezca. Se asocia un widget a un AppWidgetHostView cada vez que el host aumenta el widget.

  • De forma predeterminada, el sistema crea un AppWidgetHostView, pero el host puede crear su propia subclase de AppWidgetHostView extendiéndola.
  • A partir de Android 12 (nivel de API 31), AppWidgetHostView introduce 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 comunicar información al AppWidgetProvider sobre cómo se muestra el widget (por ejemplo, la lista de rangos de tamaños) y si el widget 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() al AppWidgetProvider.

Widgets de vinculación

Cuando un usuario agrega un widget a un host, se produce un proceso llamado vinculación. La vinculación consiste en asociar un ID de un widget de la app en particular a 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ícitamente a tu app para que pueda agregar un widget al host. Si quieres probar si tu app tiene permiso para agregar el widget, usa el método bindAppWidgetIdIfAllowed(). Si bindAppWidgetIdIfAllowed() devuelve false, tu app debe mostrar un diálogo en el que se le solicite al usuario que otorgue permiso: "permitir" para la adición del widget actual 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:

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)

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 la app.

Responsabilidades del anfitrión

Puedes especificar una serie de parámetros de configuración para los widgets con 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 el ID de este como se describió anteriormente. Cuando se quite un widget del host, llama a deleteAppWidgetId() para anular la asignación del ID del widget.

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

• 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 del widget.

  Asegúrate de que el widget esté diseñado 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 satisfacen 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 objetivo

Android 12

Android 12 (nivel de API 31) incluye un List<SizeF> adicional que contiene la lista de tamaños posibles en dp que puede adoptar una instancia de widget 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) en 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.

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

Recursos adicionales

• Consulta la documentación de referencia de Glance.