Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

Créer un hôte de widget

L'écran d'accueil Android, disponible sur la plupart des appareils Android, permet à l'utilisateur d'intégrer des widgets d'application (ou widgets) pour accéder rapidement au contenu. Si vous créez un remplacement d'écran d'accueil ou une application similaire, vous pouvez également autoriser l'utilisateur à intégrer des widgets en implémentant AppWidgetHost. La plupart des applications n'ont pas besoin de le faire, mais si vous créez votre propre hôte, il est important de comprendre les obligations contractuelles qu'un hôte accepte implicitement.

Cette page se concentre sur les responsabilités liées à la mise en œuvre d'un AppWidgetHost personnalisé. Pour obtenir un exemple spécifique d'implémentation d'un AppWidgetHost, consultez le code source de l'écran d'accueil Android LauncherAppWidgetHost.

Voici un aperçu des classes et concepts clés impliqués dans l'implémentation d'un AppWidgetHost personnalisé :

Hôte du widget d'application : AppWidgetHost fournit l'interaction avec le service AppWidget pour les applications qui intègrent des widgets dans leur UI. Un AppWidgetHost doit avoir un ID unique dans le package de l'hôte. Cet ID persiste pour toutes les utilisations de l'hôte. L'ID est généralement une valeur codée en dur que vous attribuez dans votre application.
ID du widget d'application : chaque instance de widget se voit attribuer un identifiant unique au moment de la liaison. Consultez bindAppWidgetIdIfAllowed() et, pour en savoir plus, la section Lier des widgets ci-dessous. L'hôte obtient l'identifiant unique à l'aide de allocateAppWidgetId(). Cet ID persiste pendant toute la durée de vie du widget jusqu'à ce qu'il soit supprimé de l'hôte. Tout état spécifique à l'hôte, tel que la taille et l'emplacement du widget, doit être conservé par le package d'hébergement et associé à l'ID du widget d'application.
Vue de l'hôte du widget d'application : considérez AppWidgetHostView comme un cadre dans lequel le widget est encapsulé chaque fois qu'il doit être affiché. Un widget est associé à un AppWidgetHostView chaque fois qu'il est gonflé par l'hôte.
- Par défaut, le système crée un AppWidgetHostView, mais l'hôte peut créer sa propre sous-classe de AppWidgetHostView en l'étendant.
- À partir d'Android 12 (niveau d'API 31), AppWidgetHostView introduit les méthodes setColorResources() et resetColorResources() pour gérer les couleurs surchargées de manière dynamique. L'hôte est chargé de fournir les couleurs à ces méthodes.
Groupe d'options : AppWidgetHost utilise le groupe d'options pour communiquer des informations à AppWidgetProvider sur l'affichage du widget (par exemple, la liste des plages de tailles) et pour indiquer si le widget se trouve sur l'écran de verrouillage ou sur l'écran d'accueil. Ces informations permettent à AppWidgetProvider d'adapter le contenu et l'apparence du widget en fonction de la manière dont il est affiché et de l'endroit où il est affiché. Vous pouvez utiliser updateAppWidgetOptions() et updateAppWidgetSize() pour modifier le bundle d'un widget. Ces deux méthodes déclenchent le rappel onAppWidgetOptionsChanged() vers AppWidgetProvider.

Widgets de liaison

Lorsqu'un utilisateur ajoute un widget à un hôte, un processus appelé liaison se produit. La liaison consiste à associer un ID de widget d'application particulier à un hôte spécifique et à un AppWidgetProvider spécifique.

Les API de liaison permettent également à un hôte de fournir une UI personnalisée pour la liaison. Pour utiliser ce processus, votre application doit déclarer l'autorisation BIND_APPWIDGET dans le fichier manifeste de l'hôte :

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

Mais ce n'est que la première étape. Au moment de l'exécution, l'utilisateur doit explicitement autoriser votre application à ajouter un widget à l'hôte. Pour vérifier si votre application est autorisée à ajouter le widget, utilisez la méthode bindAppWidgetIdIfAllowed(). Si bindAppWidgetIdIfAllowed() renvoie false, votre application doit afficher une boîte de dialogue invitant l'utilisateur à accorder l'autorisation : "Autoriser" pour l'ajout du widget actuel ou "Toujours autoriser" pour couvrir tous les futurs ajouts de widgets.

Cet extrait montre comment afficher la boîte de dialogue :

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

L'hôte doit vérifier si le widget ajouté par un utilisateur nécessite une configuration. Pour en savoir plus, consultez Permettre aux utilisateurs de configurer des widgets d'application.

Responsabilités de l'hôte

Vous pouvez spécifier un certain nombre de paramètres de configuration pour les widgets à l'aide des métadonnées AppWidgetProviderInfo. Vous pouvez récupérer ces options de configuration, décrites plus en détail dans les sections suivantes, à partir de l'objet AppWidgetProviderInfo associé à un fournisseur de widgets.

Tous les hôtes assument les responsabilités suivantes :

Lorsque vous ajoutez un widget, attribuez-lui un ID comme décrit précédemment. Lorsqu'un widget est supprimé de l'hôte, appelez deleteAppWidgetId() pour désallouer l'ID du widget.
Lorsque vous ajoutez un widget, vérifiez si l'activité de configuration doit être lancée. En règle générale, l'hôte doit lancer l'activité de configuration du widget si elle existe et qu'elle n'est pas marquée comme facultative en spécifiant les options configuration_optional et reconfigurable. Pour en savoir plus, consultez Mettre à jour le widget à partir de l'activité de configuration. Cette étape est nécessaire pour que de nombreux widgets puissent s'afficher.

Remarque : Gérez les cas irréguliers où l'activité de configuration ne renvoie pas de résultat ou se termine par des erreurs.
Les widgets spécifient une largeur et une hauteur par défaut dans les métadonnées AppWidgetProviderInfo. Ces valeurs sont définies dans les cellules (à partir d'Android 12, si targetCellWidth et targetCellHeight sont spécifiés) ou en dp si seuls minWidth et minHeight sont spécifiés. Consultez Attributs de dimensionnement des widgets.

Assurez-vous que le widget est disposé avec au moins ce nombre de dp. Par exemple, de nombreux hôtes alignent les icônes et les widgets dans une grille. Dans ce scénario, l'hôte ajoute par défaut un widget en utilisant le nombre minimal de cellules qui satisfont aux contraintes minWidth et minHeight.

Conseils sur votre approche

En plus des exigences listées dans la section précédente, gardez à l'esprit les conseils suivants :

Le bundle d'options peut contenir un List<SizeF> qui contient la liste des tailles possibles en dp qu'une instance de widget peut prendre. Le nombre de tailles fournies dépend de l'implémentation de l'hôte. Les hôtes fournissent généralement deux tailles pour les téléphones (portrait et paysage) et quatre tailles pour les pliables.

Le nombre de RemoteViews différents qu'un AppWidgetProvider peut fournir à RemoteViews est limité à MAX_INIT_VIEW_COUNT (16). Étant donné que les objets AppWidgetProvider mappent un objet RemoteViews à chaque taille dans List<SizeF>, ne fournissez pas plus de MAX_INIT_VIEW_COUNT tailles.

Lorsque les widgets spécifient les attributs maxResizeWidth et maxResizeHeight en dp, nous recommandons qu'un widget utilisant au moins l'un de ces attributs ne dépasse pas la taille spécifiée par les attributs.

Ressources supplémentaires

Consultez la documentation de référence sur Glance.