Aus öffentlichen Paketdaten erstellte Orientierung.
Das download_assets-Paket ermöglicht Flutter-Anwendungen, Assets lokal im Repository der App abzurufen und zu speichern, sodass sie für den Offline-Verwendung verfügbar sind. Es unterstützt das Herunterladen von Dateien von Remote-URLs und das Speichern auf dem Dateisystem des Geräts, was besonders nützlich für das Cachen von Ressourcen wie Bildern, Dokumenten oder Konfigurationsdateien ist. Das Paket funktioniert über mehrere Plattformen hinweg, einschließlich Android, iOS, macOS, Windows und Linux, und gewährleistet konsistentes Verhalten. Es vereinfacht die Asset-Verwaltung durch asynchrone Downloads und automatische Verwaltung von Dateipfaden.
Anwendungsfälle
Offline-Zugriff auf Inhalte
Remote Ressourcen zwischenspeichern
App-Ressourcen vorladen
Dynamische Inhaltaktualisierungen
Asset-Fallback-Mechanismen
Hauptmerkmale
Plattformübergreifende Unterstützung
Asynchrone Downloads
lokale Dateispeicherung
Automatische Pfadverwaltung
Unterstützung verschiedener Dateitypen
Geeignet für
Apps mit Offline-Funktionalität
inhaltsreiche Apps
Apps mit dynamischer Ressourcenbereitstellung
Entwickler, die Remote-Ressourcen verwalten
Projekte, die gecachte Daten erfordern
Hinweise
Internetberechtigung auf Mobilgeräten erforderlich
Speicherverwaltung erforderlich
Dateinamenskonflikte möglich
Keine eingebaute Wiederholungslogik
Manuelle Bereinigung heruntergeladener Dateien
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
Download_assets
About
The download_assets package is a powerful library that facilitates the process of downloading assets
into the application. With this library, you can easily download files, images, videos, and other
resources in your app, providing a smooth and efficient user experience.
Features
init
Init method for setting up the assetsDir, which is required to be called during app
initialization.
await downloadAssetsController.init();
startDownload
Starts the asset download process.
assetsUrls: A list of [AssetUrl] objects representing each file to be downloaded.
uncompressDelegates: A list of custom decompression delegates for different types of files, such
as ZIP, RAR, etc (optional).
onStartUnzipping: Called right before the start of the uncompressing process (optional).
onProgress: Called after each iteration returning the current progress (optional). The double parameter ranges from 0 to 1, where 1 indicates the completion of the download process.
onDone: Called when all files have been downloaded and uncompressed (optional).
onCancel: Cancels the ongoing download (optional).
requestQueryParams: Query params to be used in the request (optional).
requestExtraHeaders: Extra headers to be added in the request (optional).
checkSize: Specifies if the size of the file should be checked first before starting download (optional).
Uncompress delegates are responsible for implementing the logic to uncompress different types of
files, such as ZIP, RAR, etc. By providing a list of delegates, it becomes possible to support
multiple file formats during the download.
To implement your own uncompression delegate, you should implement the interface below.
/// Abstract class representing a delegate for asset decompression.abstractclassUncompressDelegate{
constUncompressDelegate();
/// Gets the file extension associated with the delegate.Stringgetextension;
/// uncompress the asset located at [compressedFilePath] to the specified [assetsDir]./// [compressedFilePath] -> The path to the compressed asset file./// [assetsDir] -> The directory where the uncompressed asset should be stored.Futureuncompress(String compressedFilePath, String assetsDir);
}
Note: This kind of delegate is essential for enabling the download process to handle various
file formats by implementing the necessary decompression logic. This flexibility allows users to
download and work with a wide range of compressed file types effortlessly. UnzipDelegate() is
already included, which handles the decompression of ZIP files.
Example
You can find an example here: https://github.com/edjostenes/download_assets/tree/master/example
Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvement,
please create an issue on the GitHub repository.