Unity Native File Picker Plugin

Available on Asset Store: https://assetstore.unity.com/packages/tools/integration/native-file-picker-for-android-ios-173238

Forum Thread: https://forum.unity.com/threads/native-file-picker-for-android-ios-open-source.912890/

Discord: https://discord.gg/UJJt549AaV

GitHub Sponsors ☕

This plugin helps you import/export files from/to various document providers on Android & iOS. On iOS, it uses UIDocumentPickerViewController which has the following requirements:

iOS 8 or later
an Apple Developer Program account (signing the app with a free account won't work)

NOTE: custom file extensions are supported on iOS only.

INSTALLATION

There are 5 ways to install this plugin:

import NativeFilePicker.unitypackage via Assets-Import Package
clone/download this repository and move the Plugins folder to your Unity project's Assets folder
import it from Asset Store
(via Package Manager) add the following line to Packages/manifest.json:
- "com.yasirkula.nativefilepicker": "https://github.com/yasirkula/UnityNativeFilePicker.git",
(via OpenUPM) after installing openupm-cli, run the following command:
- openupm add com.yasirkula.nativefilepicker

Android Setup

NativeFilePicker no longer requires any manual setup on Android.

iOS Setup

There are two ways to set up the plugin on iOS:

a. Automated Setup for iOS

set the values of Auto Setup Frameworks and Auto Setup iCloud to true at Project Settings/yasirkula/Native File Picker. By default, automated setup for iCloud is disabled. That's because this plugin uses the iCloud capability and if another plugin uses other capabilities, these plugins may conflict with each other. Set Auto Setup iCloud to true at your own risk
if your app uses custom file extensions that are unique to your app (e.g. .mydata), add them to the Window-NativeFilePicker Custom Types asset (it has explanatory tooltips). This step works even if the values of Auto Setup Frameworks and Auto Setup iCloud are set to false (this step is not needed for extensions available in this list)

b. Manual Setup for iOS

see: https://github.com/yasirkula/UnityNativeFilePicker/wiki/Manual-Setup-for-iOS

FAQ

How can I fetch the path of the saved file or the original path of the picked file?

You can't. The abstraction layers used on each platform deliberately don't return raw file paths.

Can't import/export files, it says "java.lang.ClassNotFoundException: com.yasirkula.unity.NativeFilePicker" in Logcat

If you are sure that your plugin is up-to-date, then enable Custom Proguard File option from Player Settings and add the following line to that file: -keep class com.yasirkula.unity.* { *; }

Nothing happens when I try to import/export files on Android

Make sure that you've set the Write Permission to External (SDCard) in Player Settings.

NativeFilePicker functions return Permission.Denied even though I've set "Write Permission" to "External (SDCard)"

Declare the WRITE_EXTERNAL_STORAGE permission manually in your Plugins/Android/AndroidManifest.xml file with the tools:node="replace" attribute as follows: <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" tools:node="replace"/> (you'll need to add the xmlns:tools="http://schemas.android.com/tools" attribute to the <manifest ...> element).

HOW TO

A. Importing Files

NativeFilePicker.PickFile( FilePickedCallback callback, string[] allowedFileTypes ): prompts the user to pick a file from the available document providers.

This operation is asynchronous! After user picks a file or cancels the operation, the callback is called (on main thread). FilePickedCallback takes a string parameter which stores the path of the picked file, or null if nothing is picked
allowedFileTypes determines which file types are accepted. On Android, this is the MIMEs and on iOS, this is the UTIs. For example:
- PNG files: image/png on Android and public.png on iOS
- Image files (png, jpeg, tiff, etc.): image/* on Android and public.image on iOS
- PDF files: application/pdf on Android and com.adobe.pdf on iOS
- On Android, see the following list for all available MIMEs (other MIMEs may not be supported on all devices): http://androidxref.com/4.4.4_r1/xref/frameworks/base/media/java/android/media/MediaFile.java#174
- On iOS, see the following list for all available UTIs: https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/UTIRef/Articles/System-DeclaredUniformTypeIdentifiers.html
- Also see the NativeFilePicker.ConvertExtensionToFileType function

NativeFilePicker.PickMultipleFiles( MultipleFilesPickedCallback callback, string[] allowedFileTypes ): prompts the user to pick one or more files.

MultipleFilesPickedCallback takes a string[] parameter which stores the path(s) of the picked file(s), or null if nothing is picked
Picking multiple files is only available on Android 18+ and iOS 11+. Call CanPickMultipleFiles() to see if this feature is available

NOTE: on iOS, imported files will automatically be deleted by the OS after the application is closed. If you need the files to persist, move them to Application.persistentDataPath.

B. Exporting Files

NativeFilePicker.ExportFile( string filePath, FilesExportedCallback callback = null ): prompts the user to export a file to the available document providers.

This operation is asynchronous! After user exports the file or cancels the operation, the callback is called (on main thread). FilesExportedCallback takes a bool parameter which stores whether user has exported the file or cancelled the operation
Exporting a file is only available on Android 19+ and iOS 8+. Call CanExportFiles() to see if this feature is available

NativeFilePicker.ExportMultipleFiles( string[] filePaths, FilesExportedCallback callback = null ): prompts the user to export one or more files.

Exporting multiple files is only available on Android 21+ and iOS 11+. Call CanExportMultipleFiles() to see if this feature is available

All of these functions return a NativeFilePicker.Permission value. More details about it is available below.

C. Runtime Permissions

Beginning with 6.0 Marshmallow, Android apps must request runtime permissions before accessing certain services. There are two functions to handle permissions with this plugin:

NativeFilePicker.Permission NativeFilePicker.CheckPermission(): checks whether the app has access to the document providers or not.

NativeFilePicker.Permission is an enum that can take 3 values:

Granted: we have the permission to access the document providers
ShouldAsk: we don't have permission yet, but we can ask the user for permission via RequestPermission function (see below). As long as the user doesn't select "Don't ask again" while denying the permission, ShouldAsk is returned
Denied: we don't have permission and we can't ask the user for permission. In this case, user has to give the permission from Settings. This happens when user selects "Don't ask again" while denying the permission or when user is not allowed to give that permission (parental controls etc.)

NativeFilePicker.Permission NativeFilePicker.RequestPermission(): requests permission to access the document providers from the user and returns the result. It is recommended to show a brief explanation before asking the permission so that user understands why the permission is needed and doesn't click Deny or worse, "Don't ask again". Note that the PickFile/PickMultipleFiles and ExportFile/ExportMultipleFiles functions call RequestPermission internally and execute only if the permission is granted (the result of RequestPermission is also returned).

NativeFilePicker.OpenSettings(): opens the settings for this app, from where the user can manually grant the Storage permission in case current permission state is Permission.Denied.

NOTE: on iOS, no permissions are needed and thus, these functions will always return Permission.Granted.

C. Other Functions

bool NativeFilePicker.CanPickMultipleFiles(): returns true if importing/exporting multiple files is supported (Android 18+ and iOS 11+).

bool NativeFilePicker.CanExportFiles(): returns true if exporting a single file is supported (Android 19+ and iOS 8+).

bool NativeFilePicker.CanExportMultipleFiles(): returns true if exporting multiple files is supported (Android 21+ and iOS 11+).

bool NativeFilePicker.IsFilePickerBusy(): returns true if the user is currently importing/exporting files. In that case, another PickFile, PickMultipleFiles, ExportFile or ExportMultipleFiles request will simply be ignored.

string NativeFilePicker.ConvertExtensionToFileType( string extension ): converts a file extension to its corresponding MIME on Android and UTI on iOS (don't include the period in extension, i.e. use png instead of .png).

EXAMPLE CODE

The following code has 4 functions:

if you click the left one-third of the screen, a single PDF file is picked
if you click the middle one-third of the screen, one or more image and video files are picked
if you click the right one-third of the screen, a dummy text file is created and then exported

private string pdfFileType;

void Start()
{
	pdfFileType = NativeFilePicker.ConvertExtensionToFileType( "pdf" ); // Returns "application/pdf" on Android and "com.adobe.pdf" on iOS
	Debug.Log( "pdf's MIME/UTI is: " + pdfFileType );
}

void Update()
{
	if( Input.GetMouseButtonDown( 0 ) )
	{
		// Don't attempt to import/export files if the file picker is already open
		if( NativeFilePicker.IsFilePickerBusy() )
			return;

		if( Input.mousePosition.x < Screen.width / 3 )
		{
			// Pick a PDF file
			NativeFilePicker.Permission permission = NativeFilePicker.PickFile( ( path ) =>
			{
				if( path == null )
					Debug.Log( "Operation cancelled" );
				else
					Debug.Log( "Picked file: " + path );
			}, new string[] { pdfFileType } );

			Debug.Log( "Permission result: " + permission );
		}
		else if( Input.mousePosition.x < Screen.width * 2 / 3 )
		{
#if UNITY_ANDROID
			// Use MIMEs on Android
			string[] fileTypes = new string[] { "image/*", "video/*" };
#else
			// Use UTIs on iOS
			string[] fileTypes = new string[] { "public.image", "public.movie" };
#endif

			// Pick image(s) and/or video(s)
			NativeFilePicker.Permission permission = NativeFilePicker.PickMultipleFiles( ( paths ) =>
			{
				if( paths == null )
					Debug.Log( "Operation cancelled" );
				else
				{
					for( int i = 0; i < paths.Length; i++ )
						Debug.Log( "Picked file: " + paths[i] );
				}
			}, fileTypes );

			Debug.Log( "Permission result: " + permission );
		}
		else
		{
			// Create a dummy text file
			string filePath = Path.Combine( Application.temporaryCachePath, "test.txt" );
			File.WriteAllText( filePath, "Hello world!" );

			// Export the file
			NativeFilePicker.Permission permission = NativeFilePicker.ExportFile( filePath, ( success ) => Debug.Log( "File exported: " + success ) );

			Debug.Log( "Permission result: " + permission );
		}
	}
}

yasirkula/UnityNativeFilePicker

yasirkula

Reviews

Repository Details