Android intent filter open pdf

How to open a PDF file in Android programmatically?

Opening and viewing documents in Android applications are very interesting and a must to have in every application. You can open any application present on your mobile and you will find that every application contains documents in some or the other way. And among these documents, the most popular and widely used document format is the PDF format.

PDF or Portable Document Format is a file format that has captured all the elements of a printed document. This is the most used document format. For example, in the Paytm application, you get your monthly expenses in the form of PDF document. So, if you also want to display some kind of document in your application, then you can open this PDF format document.

So, welcome to MindOrks and in this tutorial, we will learn how to open a PDF file in Android programmatically. We will cover the below topics in this tutorial:

1. Project setup
2. Ways of opening PDF in Android
3. Making UI and adding Activities for the project
4. Opening a PDF file using WebView
5. Opening a PDF file using AndoirdPdfviewer library
6. Project source code and What next?

Project setup

In this tutorial, we will make a project and try various ways of opening PDF file, Here we are going to set up our project:

• Start a new Android Studio Project
• Select Empty Activity and Next
• Name: Open-PDF-File-Android-Example
• Package name: com.mindorks.example.openpdffile
• Language: Kotlin
• Finish
• Your starting project is ready now
• Under your root directory, create a package named utils .(right-click on root directory > new > package)
• In the utils package, create one object classes: FileUtils .(right-click on utils > new > Kotlin file/class > Object class)

If you are preparing for your next Android Interview, Join our Android Professional Course to learn the latest in Android and land job at top tech companies.

Ways of opening PDF in Android

If you want to display PDF in your Android application, there are various ways of doing it. Some of the ways of opening the PDF can be:

1. From Assets: Let’s take an example, if you want to display some icons in your application then you will put all your icons in the drawable folder and then you will use those icons in your application. Same is with the case of PDF files also. If you have some PDF file that is constant and you want to display it in your application then you can put that PDF file in the assets folder and use that PDF in your app. One example can be the Terms and Conditions file. The terms and conditions files are rarely changed. So, you can put that document in the assets folder and use it.
2. From Device: The other way of opening a PDF is to open it from the device itself. Here, you can open the PDF files present in your mobile device. This is the most used approach for opening the PDF in an Android device.
3. From the Internet: Here, you can open PDF files from the internet. All you need to do is just use the URL of the PDF file and after downloading the PDF file, you can open the PDF file in your mobile application.

So, we will look upon all these ways of viewing the PDF in your Android Application. Let’s make the UI of the project.

Making UI for the project

In our example, we are going to cover four different cases:

1. Opening a PDF file using WebView
2. Opening a PDF file from assets using AndroidPdfViewer library
3. Opening a PDF file form storage using AndroidPdfViewer library
4. Opening a PDF file from the internet using AndroidPdfViewer library

So, for the first point, we will use WebViewActivity and for 2nd, 3rd, and 4th point, we will be using PdfViewActivtiy .

Create two activities named WebViewActivtiy and PdfViewActivity .(right-click on root directory > new > Activity> Empty Activity)

Now, for the above four actions, create four buttons and assign the task to open activity by those four buttons.

The code for the activity_main.xml file is:

In the MainActivity.kt file, we call the desired activity with the corresponding buttons:

We are done with the UI part. Let’s learn how to view PDF from WebView.

Opening a PDF file in Android using WebView

The very first and the easiest way of displaying the PDF file is to display it in the WebView. All you need to do is just put WebView in your layout and load the desired URL by using the webView.loadUrl() function.

So, add a WebView in the activity_web_view.xml file:

Now, open the FileUtils class of the utils package that we created at the starting of this blog and add a function named getPdfUrl that will return the URL of the PDF which we are going to view in the WebView. Here, I am using the syllabus of MindOrks Professional Course. Add below method in FileUtils class:

Now, all we need to do is open the above URL in the WebView by calling the webView.loadUrl method. Following is the code of WebViewActivity.kt file:

The last thing that you need to do is adding INTERNET permission to your application. So, add the below line in your AndroidManifest.xml file:

Now, run the application on your mobile phone and the PDF will be displayed on the screen.

Note: The opening of PDF in WebView depends on your internet speed, so wait for sometimes if your internet is slow.

Opening a PDF file in Android using AndroidPdfViewer library

There are various libraries that can be used to display PDF files in our application. In our tutorial, we will learn how to open a PDF file from Assets, Phone Storage, and from the Internet by using the AndroidPdfViewer library.

Also, we will be using PRDownloader library by MindOrks to download files from the Internet and open it by AndoridPdfViewer .

Adding dependencies and permissions

Open the app level build.gradle and add the below dependencies of AndroidPdfViewer and PRDownloader:

Since we will be reading pdf from INTERNET. Open the AndoidManifest.xml file and add the below:

The AndroiPdfViewer provides a PDFView to display PDF files in it. So, write the below code in actvity_pdf_view.xml :

We can use the AndroidPdfViewer to open the PDF from:

• Assets folder
• Phone storage
• Internet

So, we need to write the code to connect the button click of MainActivity with the above events. Create a function named checkPdfAction() and write the below code:

Call the above method from the onCreate() :

Let’s learn how to display PDF from assets, storage, and internet.

Assets Folder

Firstly, we will look upon how to view PDF, stored in the Assets Folder.

Creating an assets folder

Create an assets folder by right-clicking on main > New Folder > Assets Folder and paste the PDF document into it.

PDF file name: MindOrks_Android_Online_Professional_Course-Syllabus.pdf

Create getPdfNameFromAssets() method

Create a method named getPdfNameFromAssets in the FileUtils class. This method will return the name of the PDF file present in the assets folder:

Now, in the PdfViewActivity.kt file, create a method showPdfFromAssets which will take the file name in string format and will use the fromAssets() method of AndroidPdfViewer library to display PDF:

Call the above method from the checkPdfAction and pass the file name by calling the getPdfnameFromAssets method of FileUtils class:

Finally, run the application on your mobile device and see the output.

From Phone Storage

Now, we will look upon how to open PDF files from the Phone’s storage. So, we have to launch an intent to find the file having PDF format and the selected file will be displayed in the PDFView by calling the fromUri method.

Create a function selectPdfFromStorage() in the PdfViewActivity.kt file and add the below code:

Once, the user selects a PDF, the onActivityResult will be called:

Now, create a method named showPdfFromUri that will take a Uri and display the PDF:

Now, you can check the output by running your application on your mobile device and select the desired PDF.

PDF from Internet

Lastly, our aim is to view the PDF files from the Internet. We will first download the PDF by using the PRDownloader and then use this file to display the PDF on your PdfViewActiviy by using the same process as used for Assets and Storage but here you have to use fromFile() to add display the PDF.

So, we need to download the file first by using the PRDownloader library. Initialise it in the onCreate() method of PdfViewActivity :

Now, you need to download the file from the INTERNET by using the download() method of PRDownloader. So, create a function named downloadPdfFromInternet() in the PdfViewActivity. This function will take the URL, directory path, and file name of the file to be downloaded.

The onDownloadComplete method will be called when the file is downloaded. So, call the showPdfFromFile method and pass the downloaded file to the method:

Finally, call the downloadPdfFromInternet method from the checkPdfAction method but we need the URL, directory name and file name of the file to be downloaded. We can get the URL by calling the getPdfUrl method of FileUtils class. Now, make a function getRootDirPath method in the FileUtils class that will return the root directory:

Now, call the downloadPdfFromInternet method from checkPdfAction method of PdfViewActivity :

Finally, run the application and try to verify all the three options i.e. assets, storage and internet options to view PDF in Android Application. Try to replace the PDF link used in the above example with your own PDF URL.

There are many other methods present in the AndroidPdfViewer library. You can explore all the methods from here.

Project source code and What next?

Do share this tutorial with your fellow developers to spread the knowledge. You can read more blogs on Android on our blogging website .

Источник

Access media files from shared storage

To provide a more enriched user experience, many apps allow users to contribute and access media that’s available on an external storage volume. The framework provides an optimized index into media collections, called the media store, that allows for retrieving and updating these media files more easily. Even after your app is uninstalled, these files remain on the user’s device.

To interact with the media store abstraction, use a ContentResolver object that you retrieve from your app’s context:

Kotlin

The system automatically scans an external storage volume and adds media files to the following well-defined collections:

• Images, including photographs and screenshots, which are stored in the DCIM/ and Pictures/ directories. The system adds these files to the MediaStore.Images table.
• Videos, which are stored in the DCIM/ , Movies/ , and Pictures/ directories. The system adds these files to the MediaStore.Video table.
• Audio files, which are stored in the Alarms/ , Audiobooks/ , Music/ , Notifications/ , Podcasts/ , and Ringtones/ directories. Additionally, the system recognizes audio playlists that are in the Music/ or Movies/ directories, as well as voice recordings that are in the Recordings/ directory. The system adds these files to the MediaStore.Audio table. The recordings directory isn’t available on Android 11 (API level 30) and lower.
• Downloaded files, which are stored in the Download/ directory. On devices that run Android 10 (API level 29) and higher, these files are stored in the MediaStore.Downloads table. This table isn’t available on Android 9 (API level 28) and lower.

The media store also includes a collection called MediaStore.Files . Its contents depend on whether your app uses scoped storage, available on apps that target Android 10 or higher:

• If scoped storage is enabled, the collection shows only the photos, videos, and audio files that your app has created. Most developers won’t need to use MediaStore.Files to view media files from other apps, but if you have a specific requirement to do so, you can declare the READ_EXTERNAL_STORAGE permission. It’s recommended, however, that you use the MediaStore APIs to open files that your app hasn’t created.
• If scoped storage is unavailable or not being used, the collection shows all types of media files.

Request necessary permissions

Before performing operations on media files, make sure your app has declared the permissions that it needs to access these files. Keep in mind, however, that your app shouldn’t declare permissions that it doesn’t need or use.

Storage permission

The permissions model for accessing media files in your app depends on whether your app uses scoped storage, available on apps that target Android 10 or higher.

Scoped storage enabled

If your app uses scoped storage, it should request storage-related permissions only for devices that run Android 9 (API level 28) or lower. You can apply this condition by adding the android:maxSdkVersion attribute to the permission declaration in your app’s manifest file:

Don’t unnecessarily request storage-related permissions for devices that run Android 10 or higher. Your app can contribute to well-defined media collections, including the MediaStore.Downloads collection, without requesting any storage-related permissions. If you’re developing a camera app, for example, you don’t need to request storage-related permissions because your app owns the images that you’re writing to the media store.

To access files that other apps have created, the following conditions must each be true:

If your app wants to access a file within the MediaStore.Downloads collection that your app didn’t create, you must use the Storage Access Framework. To learn more about how to use this framework, see the guide on how to access documents and other files.

Scoped storage unavailable

If your app is used on a device that runs Android 9 or lower, or if your app has temporarily opted out of scoped storage, you must request the READ_EXTERNAL_STORAGE permission to access media files. If you want to modify media files, you must request the WRITE_EXTERNAL_STORAGE permission, as well.

Media location permission

If your app targets Android 10 (API level 29) or higher, in order for your app to retrieve unredacted Exif metadata from photos, you need to declare the ACCESS_MEDIA_LOCATION permission in your app’s manifest, then request this permission at runtime.

Check for updates to the media store

To access media files more reliably, particularly if your app caches URIs or data from the media store, check whether the media store version has changed compared to when you last synced your media data. To perform this check for updates, call getVersion() . The returned version is a unique string that changes whenever the media store changes substantially. If the returned version is different from the last synced version, rescan and resync your app’s media cache.

Complete this check at app process startup time. There’s no need to check the version each time you query the media store.

Don’t assume any implementation details regarding the version number.

Query a media collection

To find media that satisfies a particular set of conditions, such as a duration of 5 minutes or longer, use an SQL-like selection statement similar to the one shown in the following code snippet:

Kotlin

When performing such a query in your app, keep the following in mind:

• Call the query() method in a worker thread.
• Cache the column indices so that you don’t need to call getColumnIndexOrThrow() each time you process a row from the query result.
• Append the ID to the content URI, as shown in the code snippet.
• Devices that run Android 10 and higher require column names that are defined in the MediaStore API. If a dependent library within your app expects a column name that’s undefined in the API, such as «MimeType» , use CursorWrapper to dynamically translate the column name in your app’s process.

Load file thumbnails

If your app shows multiple media files and requests that the user choose one of these files, it’s more efficient to load preview versions—or thumbnails—of the files instead of the files themselves.

To load the thumbnail for a given media file, use loadThumbnail() and pass in the size of the thumbnail that you want to load, as shown in the following code snippet:

Kotlin

Open a media file

The specific logic that you use to open a media file depends on whether the media content is best represented as a file descriptor, a file stream, or a direct file path:

File descriptor

To open a media file using a file descriptor, use logic similar to that shown in the following code snippet:

Kotlin

File stream

To open a media file using a file stream, use logic similar to that shown in the following code snippet:

Kotlin

Direct file paths

To help your app work more smoothly with third-party media libraries, Android 11 (API level 30) and higher allow you to use APIs other than the MediaStore API to access media files from shared storage. You can instead access media files directly using either of the following APIs:

• The File API.
• Native libraries, such as fopen() .

If you don’t have any storage-related permissions, you can access files in your app-specific directory, as well as media files that are attributed to your app, using the File API.

If your app tries to access a file using the File API and it doesn’t have the necessary permissions, a FileNotFoundException occurs.

To access other files in shared storage on a device that runs Android 10 (API level 29), it’s recommended that you temporarily opt out of scoped storage by setting requestLegacyExternalStorage to true in your app’s manifest file. In order to access media files using native files methods on Android 10, you must also request the READ_EXTERNAL_STORAGE permission.

Considerations when accessing media content

When accessing media content, keep in mind the considerations discussed in the following sections.

Cached data

If your app caches URIs or data from the media store, periodically check for updates to the media store. This check allows your app-side, cached data to stay in sync with the system-side, provider data.

Performance

When you perform sequential reads of media files using direct file paths, the performance is comparable to that of the MediaStore API.

When you perform random reads and writes of media files using direct file paths, however, the process can be up to twice as slow. In these situations, we recommend using the MediaStore API instead.

DATA column

When you access an existing media file, you can use the value of the DATA column in your logic. That’s because this value has a valid file path. However, don’t assume that the file is always available. Be prepared to handle any file-based I/O errors that could occur.

To create or update a media file, on the other hand, don’t use the value of the DATA column. Instead, use the values of the DISPLAY_NAME and RELATIVE_PATH columns.

Storage volumes

Apps that target Android 10 or higher can access the unique name that the system assigns to each external storage volume. This naming system helps you efficiently organize and index content, and it gives you control over where new media files are stored.

The following volumes are particularly useful to keep in mind:

• The VOLUME_EXTERNAL volume provides a view of all shared storage volumes on the device. You can read the contents of this synthetic volume, but you cannot modify the contents.
• The VOLUME_EXTERNAL_PRIMARY volume represents the primary shared storage volume on the device. You can read and modify the contents of this volume.

You can discover other volumes by calling MediaStore.getExternalVolumeNames() :

Kotlin

Location where media was captured

Some photographs and videos contain location information in their metadata, which shows the place where a photograph was taken or where a video was recorded.

To access this location information in your app, use one API for photograph location information and another API for video location information.

Photographs

If your app uses scoped storage, the system hides location information by default. To access this information, complete the following steps:

Request the ACCESS_MEDIA_LOCATION permission in your app’s manifest.

From your MediaStore object, get the exact bytes of the photograph by calling setRequireOriginal() and pass in the URI of the photograph, as shown in the following code snippet:

Kotlin

Videos

To access location information within a video’s metadata, use the MediaMetadataRetriever class, as shown in the following code snippet. Your app doesn’t need to request any additional permissions to use this class.

Kotlin

Sharing

Some apps allow users to share media files with each other. For example, social media apps give users the ability to share photos and videos with friends.

To share media files, use a content:// URI, as recommended in the guide to creating a content provider.

App attribution of media files

When scoped storage is enabled for an app that targets Android 10 or higher, the system attributes an app to each media file, which determines the files that your app can access when it hasn’t requested any storage permissions. Each file can be attributed to only one app. Therefore, if your app creates a media file that’s stored in the photos, videos, or audio files media collection, your app has access to the file.

If the user uninstalls and reinstalls your app, however, you must request READ_EXTERNAL_STORAGE to access the files that your app originally created. This permission request is required because the system considers the file to be attributed to the previously-installed version of the app, rather than the newly-installed one.

Add an item

To add a media item to an existing collection, call code similar to the following. This code snippet accesses the VOLUME_EXTERNAL_PRIMARY volume on devices that run Android 10 or higher. That’s because, on these devices, you can only modify the contents of a volume if it’s the primary volume, as described in the storage volumes section.

Kotlin

Toggle pending status for media files

If your app performs potentially time-consuming operations, such as writing to media files, it’s useful to have exclusive access to the file as it’s being processed. On devices that run Android 10 or higher, your app can get this exclusive access by setting the value of the IS_PENDING flag to 1. Only your app can view the file until your app changes the value of IS_PENDING back to 0.

The following code snippet builds upon the previous code snippet. The following snippet shows how to use the IS_PENDING flag when storing a long song in the directory corresponding to the MediaStore.Audio collection:

Kotlin

Give a hint for file location

When your app stores media on a device running Android 10, the media is organized based on its type by default. For example, new image files are placed by default in the Environment.DIRECTORY_PICTURES directory, which corresponds to the MediaStore.Images collection.

If your app is aware of a specific location where files should be stored, such as a photo album called Pictures/MyVacationPictures, you can set MediaColumns.RELATIVE_PATH to provide the system a hint for where to store the newly-written files.

Update an item

To update a media file that your app owns, run code similar to the following:

Kotlin

If scoped storage is unavailable or not enabled, the process shown in the preceding code snippet also works for files that your app doesn’t own.

Update in native code

If you need to write media files using native libraries, pass the file’s associated file descriptor from your Java-based or Kotlin-based code into your native code.

The following code snippet shows how to pass a media object’s file descriptor into your app’s native code:

Kotlin

Update other apps’ media files

If your app uses scoped storage, it ordinarily cannot update a media file that a different app contributed to the media store.

It’s still possible to get user consent to modify the file, however, by catching the RecoverableSecurityException that the platform throws. You can then request that the user grant your app write access to that specific item, as shown in the following code snippet:

Kotlin

Complete this process each time your app needs to modify a media file that it didn’t create.

Alternatively, if your app runs on Android 11 or higher, you can allow users to grant your app write access to a group of media files. Call the createWriteRequest() method, as described in the section on how to manage groups of media files.

If your app has another use case that isn’t covered by scoped storage, file a feature request and temporarily opt out of scoped storage.

Remove an item

To remove an item that your app no longer needs in the media store, use logic similar to what’s shown in the following code snippet:

Kotlin

If scoped storage is unavailable or isn’t enabled, you can use the preceding code snippet to remove files that other apps own. If scoped storage is enabled, however, you need to catch a RecoverableSecurityException for each file that your app wants to remove, as described in the section on updating media items.

If your app runs on Android 11 or higher, you can allow users to choose a group of media files to remove. Call the createTrashRequest() method or the createDeleteRequest() method, as described in the section on how to manage groups of media files.

If your app has another use case that isn’t covered by scoped storage, file a feature request and temporarily opt out of scoped storage.

Detect updates to media files

Your app might need to identify storage volumes containing media files that apps added or modified, compared to a previous point in time. To detect these changes most reliably, pass the storage volume of interest into getGeneration() . As long as the media store version doesn’t change, the return value of this method monotonically increases over time.

In particular, getGeneration() is more robust than the dates in media columns, such as DATE_ADDED and DATE_MODIFIED . That’s because those media column values could change when an app calls setLastModified() , or when the user changes the system clock.

Manage groups of media files

On Android 11 and higher, you can ask the user to select a group of media files, then update these media files in a single operation. These methods offer better consistency across devices, and the methods make it easier for users to manage their media collections.

The methods that provide this «batch update» functionality include the following:

createWriteRequest() Request that the user grant your app write access to the specified group of media files. createFavoriteRequest() Request that the user marks the specified media files as some of their «favorite» media on the device. Any app that has read access to this file can see that the user has marked the file as a «favorite». createTrashRequest()

Request that the user place the specified media files in the device’s trash. Items in the trash are permanently deleted after a system-defined time period.

Request that the user permanently delete the specified media files immediately, without placing them in the trash beforehand.

After calling any of these methods, the system builds a PendingIntent object. After your app invokes this intent, users see a dialog that requests their consent for your app to update or delete the specified media files.

For example, here is how to structure a call to createWriteRequest() :

Kotlin

Evaluate the user’s response. If the user provided consent, proceed with the media operation. Otherwise, explain to the user why your app needs the permission:

Kotlin

Media management permission

Users might trust a particular app to perform media management, such as making frequent edits to media files. If your app targets Android 11 or higher and isn’t the device’s default gallery app, you must show a confirmation dialog to the user each time your app attempts to modify or delete a file.

If your app targets Android 12 (API level 31) or higher, you can request that users grant your app access to the Media management special permission. This permission allows your app to do each of the following without needing to prompt the user for each file operation:

To do so, complete the following steps:

Declare the MANAGE_MEDIA permission and the READ_EXTERNAL_STORAGE permission in your app’s manifest file.

In order to call createWriteRequest() without showing a confirmation dialog, declare the ACCESS_MEDIA_LOCATION permission as well.

In your app, show a UI to the user to explain why they might want to grant media management access to your app.

Invoke the ACTION_REQUEST_MANAGE_MEDIA intent action. This takes users to the Media management apps screen in system settings. From here, users can grant the special app access.

Use cases that require an alternative to media store

If your app primarily performs one of the following roles, consider an alternative to the MediaStore APIs.

Work with other types of files

If your app works with documents and files that don’t exclusively contain media content, such as files that use the EPUB or PDF file extension, use the ACTION_OPEN_DOCUMENT intent action, as described in the guide on how to store and access documents and other files.

File sharing in companion apps

In cases where you provide a suite of companion apps—such as a messaging app and a profile app—set up file sharing using content:// URIs. We also recommend this workflow as a security best practice.

Additional resources

For more information about how to store and access media, consult the following resources.

Samples

Videos

Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.

Источник