Download Manager with Progress Bar Android Example
Downloading files from the internet is a common task for many Android apps. Whether it is an image, a video, a PDF, or any other type of file, you want to provide a smooth and reliable downloading experience for your users. That's why you need a download manager.
A download manager is a system service that handles long-running HTTP downloads. It allows you to request, monitor, control, and manage multiple downloads in the background. It also handles common issues such as network failures, device reboots, and app updates.
download manager with progress bar android example
DOWNLOAD: https://tlniurl.com/2vvsuD
One of the most important features of a download manager is a progress bar. A progress bar is a visual indicator that shows how much of a file has been downloaded. It helps the user to estimate the remaining time and bandwidth consumption. It also gives feedback on the download status and any errors that may occur.
In this article, you will learn how to use a download manager with progress bar in your Android app. You will see two ways of implementing this feature: using the built-in Android DownloadManager class, and using an external library called Fetch. You will also learn how to customize your download manager with various options and settings.
How to use Android DownloadManager class
The Android DownloadManager class is a system service that you can access from your app using the getSystemService() method. It provides a simple and easy-to-use API for requesting and managing downloads.
How to create a DownloadManager instance and request a download
To create a DownloadManager instance, you need to pass the Context.DOWNLOAD_SERVICE constant as an argument to the getSystemService() method. For example:
How to use DownloadManager with ProgressBar in Android
Android DownloadManager example with ProgressBar and Notification
DownloadProgressBar: an Android library for custom progress bar with download animation
Android download file from URL with progress bar
Using Firebase Storage and DownloadManager to show progress bar in Android
Android DownloadManager tutorial with RecyclerView and ProgressBar
How to create a circular progress bar for download in Android
Android download large file with progress bar and pause/resume feature
How to implement a custom download manager with progress bar in Android
Android download multiple files with progress bar using AsyncTask
How to show horizontal progress bar while downloading PDF file in Android
Android download image from URL and show progress bar using Glide
How to use RxJava and Retrofit to download file with progress bar in Android
Android download video from URL and show progress bar using ExoPlayer
How to use WorkManager to download file and update progress bar in Android
Android download zip file with progress bar and unzip it
How to use Kotlin coroutines and OkHttp to download file with progress bar in Android
Android download APK file with progress bar and install it programmatically
How to use Dagger Hilt and DownloadManager to show progress bar in Android
Android download audio file with progress bar and play it using MediaPlayer
How to use LiveData and ViewModel to update progress bar while downloading file in Android
Android download JSON data with progress bar using Volley
How to use Service and Broadcast Receiver to download file and show progress bar in Android
Android download wallpaper with progress bar and set it as home screen background
How to use MVVM pattern and Data Binding to show progress bar while downloading file in Android
Android download SQLite database with progress bar and copy it to internal storage
How to use Jetpack Compose and DownloadManager to show progress bar in Android
Android download CSV file with progress bar and parse it using OpenCSV
How to use Room database and DownloadManager to store downloaded file and show progress bar in Android
Android download XML file with progress bar and parse it using XmlPullParser
How to use Navigation Component and DownloadManager to navigate between fragments and show progress bar in Android
Android download ebook with progress bar and read it using PdfView or EpubView
How to use ConstraintLayout and DownloadManager to create a responsive layout for showing progress bar in Android
Android download podcast with progress bar and listen it using MediaBrowserService or MediaSessionCompat
How to use MotionLayout and DownloadManager to create a smooth transition animation for showing progress bar in Android
Android download subtitle file with progress bar and sync it with video player
How to use Material Design Components and DownloadManager to create a beautiful UI for showing progress bar in Android
Android download font file with progress bar and apply it using Typeface or FontProvider
How to use Firebase Analytics and DownloadManager to track the download events and show progress bar in Android
Android download GIF file with progress bar and display it using ImageView or LottieAnimationView
How to use Firebase Remote Config and DownloadManager to customize the appearance of the progress bar in Android
Android download Instagram post with progress bar using Instagram API or web scraping
How to use Firebase Cloud Messaging and DownloadManager to send push notifications when the download is completed or failed and show progress bar in Android
Android download Google Drive file with progress bar using Google Drive API or SAF (Storage Access Framework)
How to use Firebase Crashlytics and DownloadManager to report any crashes or errors during the download process and show progress bar in Android
DownloadManager downloadManager = (DownloadManager) context.getSystemService(Context.DOWNLOAD_SERVICE);
To request a download, you need to create a DownloadManager.Request object and pass it to the enqueue() method of the DownloadManager instance. The Request object takes an Uri object as an argument, which represents the URL of the file you want to download. For example:
Uri uri = Uri.parse(" DownloadManager.Request request = new DownloadManager.Request(uri); long downloadId = downloadManager.enqueue(request);
The enqueue() method returns a long value that represents the unique ID of the download. You can use this ID later to query or control the download.
How to set the notification visibility and destination directory
By default, the DownloadManager shows a notification in the status bar when a download starts, progresses, and completes. You can change this behavior by using the setNotificationVisibility() method of the Request object. This method takes an int constant as an argument, which can be one of the following:
DownloadManager.Request.VISIBILITY_VISIBLE: The notification is visible while downloading.
DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED: The notification is visible while downloading and after completion.
DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_ONLY_COMPLETION: The notification is only visible after completion.
DownloadManager.Request.VISIBILITY_HIDDEN: The notification is hidden.
For example:
request.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
By default, the DownloadManager saves the downloaded file in the external storage directory of the device. You can change this by using the setDestinationInExternalFilesDir() or setDestinationInExternalPublicDir() methods of the Request object. These methods take a Context, a String, and a String as arguments, which represent the context, the type of directory, and the file name respectively. For example:
request.setDestinationInExternalFilesDir(context, Environment.DIRECTORY_DOWNLOADS, "file.pdf");
This will save the file in the app-specific external files directory under the Downloads subdirectory.
How to register a broadcast receiver to get the download status and id
To get notified when a download is completed or failed, you need to register a broadcast receiver that listens to the DownloadManager.ACTION_DOWNLOAD_COMPLETE and DownloadManager.ACTION_NOTIFICATION_CLICKED intents. You can do this by using the registerReceiver() method of the Context object. For example:
BroadcastReceiver receiver = new BroadcastReceiver() @Override public void onReceive(Context context, Intent intent) String action = intent.getAction(); if (action.equals(DownloadManager.ACTION_DOWNLOAD_COMPLETE)) // Get the download id from the intent long id = intent.getLongExtra(DownloadManager.EXTRA_DOWNLOAD_ID, -1); // Query the download manager for the status and other details DownloadManager.Query query = new DownloadManager.Query(); query.setFilterById(id); Cursor cursor = downloadManager.query(query); if (cursor.moveToFirst()) int status = cursor.getInt(cursor.getColumnIndex(DownloadManager.COLUMN_STATUS)); String uri = cursor.getString(cursor.getColumnIndex(DownloadManager.COLUMN_LOCAL_URI)); // Handle the download status switch (status) case DownloadManager.STATUS_SUCCESSFUL: // Download completed successfully break; case DownloadManager.STATUS_FAILED: // Download failed break; case DownloadManager.STATUS_PAUSED: // Download paused break; case DownloadManager.STATUS_PENDING: // Download pending break; case DownloadManager.STATUS_RUNNING: // Download running break; cursor.close(); else if (action.equals(DownloadManager.ACTION_NOTIFICATION_CLICKED)) // Handle the notification click ; // Register the receiver with the intent filter IntentFilter filter = new IntentFilter(); filter.addAction(DownloadManager.ACTION_DOWNLOAD_COMPLETE); filter.addAction(DownloadManager.ACTION_NOTIFICATION_CLICKED); context.registerReceiver(receiver, filter);
Don't forget to unregister the receiver when you don't need it anymore by using the unregisterReceiver() method of the Context object.
How to show progress bar while downloading
To show a progress bar while downloading, you need to use a ProgressBar widget in your XML layout. You can customize its appearance and style by using various attributes. For example:
This will create a horizontal progress bar with a custom drawable as its background.
How to use Timer and Cursor to query the download progress
To update the progress bar with the current download progress, you need to query the download manager periodically and get the downloaded bytes and total bytes of the file. You can do this by using a Timer and a Cursor. For example:
// Create a timer task that runs every second TimerTask timerTask = new TimerTask() @Override public void run() // Query the download manager for the downloaded bytes and total bytes DownloadManager.Query query = new DownloadManager.Query(); query.setFilterById(downloadId); Cursor cursor = downloadManager.query(query); if (cursor.moveToFirst()) int downloadedBytes = cursor.getInt(cursor.getColumnIndex(DownloadManager.COLUMN_BYTES_DOWNLOADED_SO_FAR)); int totalBytes = cursor.getInt(cursor.getColumnIndex(DownloadManager.COLUMN_TOTAL_SIZE_BYTES)); // Calculate the download progress percentage int progress = (int) ((downloadedBytes * 100L) / totalBytes); // Update the progress bar on the UI thread using a handler handler.post(new Runnable() @Override public void run() progressBar.setProgress(progress); ); cursor.close(); ; // Create a timer and schedule the timer task Timer timer = new Timer(); timer.schedule(timerTask, 0, 1000);
This will update the progress bar every second with the current download progress percentage. How to use Fetch library for advanced download management
If you want more control and flexibility over your download manager, you can use an external library called Fetch. Fetch is a powerful and customizable download manager library for Android. It supports parallel downloads, download priority, network type, group, tag, listener, and more. It also has a built-in database to store and manage download information.
How to add Fetch dependency and configure Fetch instance
To use Fetch in your app, you need to add the following dependency to your app's build.gradle file:
dependencies implementation 'androidx.tonyodev.fetch2:xfetch2:3.1.6'
To create a Fetch instance, you need to use the FetchConfiguration class and pass it to the Fetch.Impl.getDefaultInstance() method. The FetchConfiguration class allows you to customize various aspects of the download manager, such as the namespace, the downloader, the logger, the network type, the concurrent limit, and more. For example:
FetchConfiguration fetchConfiguration = new FetchConfiguration.Builder(context) .setNamespace("MyApp") .setDownloader(new OkHttpDownloader()) .setLogger(new FetchTimberLogger()) .setNetworkType(NetworkType.ALL) .setConcurrentLimit(3) .build(); Fetch fetch = Fetch.Impl.getDefaultInstance(fetchConfiguration);
This will create a Fetch instance with the namespace "MyApp", the OkHttp downloader, the Timber logger, the network type ALL, and the concurrent limit 3.
How to enqueue, pause, resume, cancel, and delete downloads
To enqueue a download, you need to create a Request object and pass it to the enqueue() method of the Fetch instance. The Request object takes two String arguments, which represent the URL and the file path of the download. You can also set various options and settings for the request, such as the priority, the network type, the group, the tag, and the headers. For example:
Request request = new Request(" "/storage/emulated/0/Download/file.pdf"); request.setPriority(Priority.HIGH); request.setNetworkType(NetworkType.WIFI_ONLY); request.setGroupId(1); request.setTag("PDF"); request.addHeader("Authorization", "Bearer token"); fetch.enqueue(request, updatedRequest -> // Download enqueued successfully , error -> // Download enqueued failed );
This will enqueue a download request with high priority, wifi-only network type, group id 1, tag "PDF", and an authorization header.
To pause a download, you need to pass the download id to the pause() method of the Fetch instance. For example:
fetch.pause(downloadId);
To resume a download, you need to pass the download id to the resume() method of the Fetch instance. For example:
fetch.resume(downloadId);
To cancel a download, you need to pass the download id to the cancel() method of the Fetch instance. For example:
fetch.cancel(downloadId);
To delete a download, you need to pass the download id to the delete() method of the Fetch instance. This will also delete the downloaded file from the device. For example:
fetch.delete(downloadId); How to set download priority, network type, group, tag, and listener
To set the download priority, you need to use the setPriority() method of the Request object. This method takes a Priority enum as an argument, which can be one of the following:
Priority.HIGH: The download will be processed with high priority.
Priority.NORMAL: The download will be processed with normal priority.
Priority.LOW: The download will be processed with low priority.
For example:
request.setPriority(Priority.HIGH);
This will set the download priority to high.
To set the network type, you need to use the setNetworkType() method of the Request object. This method takes a NetworkType enum as an argument, which can be one of the following:
NetworkType.ALL: The download can be processed on any network type.
NetworkType.WIFI_ONLY: The download can only be processed on wifi network.
NetworkType.UNMETERED: The download can only be processed on unmetered network.
For example:
request.setNetworkType(NetworkType.WIFI_ONLY);
This will set the network type to wifi-only.
To set the group id, you need to use the setGroupId() method of the Request object. This method takes an int value as an argument, which represents the id of the group that the download belongs to. You can use this to group multiple downloads together and perform batch operations on them. For example:
request.setGroupId(1);
This will set the group id to 1.
To set the tag, you need to use the setTag() method of the Request object. This method takes a String value as an argument, which represents a tag that can be used to identify or filter downloads. You can use this to categorize or label your downloads based on some criteria. For example:
request.setTag("PDF");
This will set the tag to "PDF".
To set the listener, you need to use the addListener() method of the Fetch instance. This method takes a FetchListener interface as an argument, which allows you to listen to various events and callbacks related to your downloads. You can use this to update your UI or perform some actions based on the download status. For example:
fetch.addListener(new FetchListener() @Override public void onAdded(@NotNull Download download) // Download added @Override public void onCancelled(@NotNull Download download) // Download cancelled @Override public void onCompleted(@NotNull Download download) // Download completed @Override public void onDeleted(@NotNull Download download) // Download deleted @Override public void onDownloadBlockUpdated(@NotNull Download download, @NotNull DownloadBlock downloadBlock, int i) // Download block updated @Override public void onError(@NotNull Download download, @NotNull Error error, @Nullable Throwable throwable) // Download error @Override public void onPaused(@NotNull Download download) // Download paused @Override public void onProgress(@NotNull Download download, long l, long l1) // Download progress @Override public void onQueued(@NotNull Download download, boolean b) // Download queued @Override public void onRemoved(@NotNull Download download) // Download removed @Override public void onResumed(@NotNull Download download) // Download resumed @Override public void onStarted(@NotNull Download download, @NotNull List list, int i) // Download started @Override public void onWaitingNetwork(@NotNull Download download) // Download waiting for network );
Conclusion
In this article, you have learned how to use a download manager with progress bar in your Android app. You have seen two ways of implementing this feature: using the built-in Android DownloadManager class, and using an external library called Fetch. You have also learned how to customize your download manager with various options and settings.
Using a download manager with progress bar can improve your app's performance and user experience. It can also help you handle common issues such as network failures, device reboots, and app updates. It can also give you more control and flexibility over your downloads.If you want to try out the examples in this article, you can download the source code from GitHub. You can also find more tutorials and resources on how to use a download manager with progress bar in your Android app.
We hope you have enjoyed this article and learned something new. If you have any questions, comments, or feedback, please feel free to share them with us. We would love to hear from you and help you with your Android development journey.
FAQs
Here are some frequently asked questions about using a download manager with progress bar in your Android app:
Q: How can I cancel all downloads at once?
A: You can use the cancelAll() method of the Fetch instance to cancel all downloads at once. For example:
fetch.cancelAll();
Q: How can I delete all downloads at once?
A: You can use the deleteAll() method of the Fetch instance to delete all downloads at once. This will also delete the downloaded files from the device. For example:
fetch.deleteAll();
Q: How can I filter downloads by group, tag, or status?
A: You can use the getDownloads() method of the Fetch instance to get a list of downloads that match a given query. The query can be created using the FetchQuery class, which allows you to specify various filters and conditions. For example:
FetchQuery query = new FetchQuery.Builder() .setGroupId(1) .setTag("PDF") .setStatus(Status.COMPLETED) .build(); fetch.getDownloads(query, result -> // Handle the result list of downloads );
Q: How can I pause or resume all downloads at once?
A: You can use the pauseGroup() or resumeGroup() methods of the Fetch instance to pause or resume all downloads that belong to a given group id. For example:
fetch.pauseGroup(1); fetch.resumeGroup(1);
Q: How can I change the download directory or file name after enqueuing a download?
A: You can use the updateRequest() method of the Fetch instance to update the download request with a new file path or file name. For example:
Request request = fetch.getRequest(downloadId); request.setFile("/storage/emulated/0/Download/new_file.pdf"); fetch.updateRequest(downloadId, request); 44f88ac181