Aller au contenu

@capgo/capacitor-asset-cache

Mettez en cache les images et vidéos du CDN dans le stockage persistant de l'app et liez-les comme sources média locales

Sources d'affichage locales uniquement

src, resolve, et bind ne renvoie une source qu'une fois qu'un fichier local existe. Votre balise img ou video reçoit alors une URL webview locale.

Stockage natif persistant

Les assets en cache résident dans le stockage persistant propre à l’app, et non dans le dossier de cache de la plateforme, que le système peut purger sous pression.

Support CDN protégé

Passez des headers au fetch natif pour les assets signés ou authentifiés, tandis que l'élément web charge uniquement le fichier local.

Liaison compatible avec votre framework

Liez la résolution du cache natif au HTML pur, aux refs React, aux refs Vue ou à tout framework capable d'assigner un src d'image ou de vidéo.

Mettez en cache les images et vidéos du CDN dans le stockage persistant de l'app et liez-les comme sources média locales

Commencez par cancel() et les autres méthodes principales listées ci-dessous.

PlateformeSupportNotes
iOSOuiNatif
AndroidOuiNatif
Le WebNonProtéger avec Capacitor.getPlatform()

Utilisez Asset Cache lorsque votre application affiche des médias distants volumineux qui doivent résister aux contraintes normales de stockage :

  • vidéos d'onboarding ou marketing diffusées depuis un CDN
  • images hero, galeries ou séquences d'images réutilisées d'une session à l'autre
  • médias protégés nécessitant des en-têtes de requête
  • écrans tolérants au mode hors ligne où un asset local déjà récupéré suffit
  • applications Capacitor où <img> et <video> ne doit pas récupérer directement les URL protégées
  • configure(options) définit le CDN par défaut et le comportement de revalidation.
  • bind(element, path, options?) met à jour un élément image ou vidéo quand le fichier local est prêt.
  • src(path, options?) renvoie une chaîne de source locale pour l'état du framework.
  • resolve(path, options?) renvoie la source locale ainsi que les métadonnées du cache.
  • get(options) résout une URL distante en métadonnées de fichier natif persistant.
  • remove(options) supprime un asset mis en cache par clé ou par URL.
  • clear() supprime tous les assets en cache gérés par le plugin.
  • list() renvoie les assets en cache qui existent toujours sur le disque.
  • getCacheSize() renvoie le nombre total d'octets mis en cache.
  • getPluginVersion() renvoie le marqueur de version de l'implémentation native.

Le cache peut être vérifié de différentes manières, par asset ou via les paramètres par défaut :

StratégieComportement
neverUtiliser le fichier local s'il est présent.
ttlRetélécharger après maxAgeSeconds.
alwaysRevalider à chaque appel et envoyer les validateurs connus.
etagUtiliser le validateur HTTP ETag connu s'il est présent.
last-modifiedUtiliser le validateur HTTP Last-Modified connu s'il est présent.

Sur iOS, les fichiers sont stockés dans Application Support et la racine du cache est exclue de la sauvegarde iCloud. Sur Android, les fichiers sont stockés dans le répertoire de fichiers internes de l’application.

Le cache est masqué dans le bac à sable de l’application et n’apparaît pas comme un média utilisateur public. Il est supprimé lors de la désinstallation de l’application, lorsque l’utilisateur efface les données de l’application, ou lorsque votre application appelle clear() ou remove().

Si vous utilisez @capgo/capacitor-asset-cache pour planifier le chargement de médias persistants, connectez-l’à Prise en main pour les détails d'implémentation, @capgo/capacitor-downloader for explicit background downloads, @capgo/capacitor-file pour l’accès aux fichiers locaux en général, et Utiliser @capgo/capacitor-asset-cache pour le tutoriel.