-
public final class SimpleStorage
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classSimpleStorage.Companion
-
Field Summary
Fields Modifier and Type Field Description private StorageAccessCallbackstorageAccessCallbackprivate FolderPickerCallbackfolderPickerCallbackprivate FilePickerCallbackfilePickerCallbackprivate CreateFileCallbackcreateFileCallbackprivate FileReceiverCallbackfileReceiverCallbackprivate IntegerrequestCodeStorageAccessprivate IntegerrequestCodeFolderPickerprivate IntegerrequestCodeFilePickerprivate IntegerrequestCodeCreateFileprivate final Contextcontext
-
Constructor Summary
Constructors Constructor Description SimpleStorage(Activity activity, Bundle savedState)SimpleStorage(ComponentActivity activity, Bundle savedState)SimpleStorage(Fragment fragment, Bundle savedState)
-
Method Summary
Modifier and Type Method Description final StorageAccessCallbackgetStorageAccessCallback()final UnitsetStorageAccessCallback(StorageAccessCallback storageAccessCallback)final FolderPickerCallbackgetFolderPickerCallback()final UnitsetFolderPickerCallback(FolderPickerCallback folderPickerCallback)final FilePickerCallbackgetFilePickerCallback()final UnitsetFilePickerCallback(FilePickerCallback filePickerCallback)final CreateFileCallbackgetCreateFileCallback()final UnitsetCreateFileCallback(CreateFileCallback createFileCallback)final FileReceiverCallbackgetFileReceiverCallback()final UnitsetFileReceiverCallback(FileReceiverCallback fileReceiverCallback)final IntegergetRequestCodeStorageAccess()final UnitsetRequestCodeStorageAccess(Integer requestCodeStorageAccess)final IntegergetRequestCodeFolderPicker()final UnitsetRequestCodeFolderPicker(Integer requestCodeFolderPicker)final IntegergetRequestCodeFilePicker()final UnitsetRequestCodeFilePicker(Integer requestCodeFilePicker)final IntegergetRequestCodeCreateFile()final UnitsetRequestCodeCreateFile(Integer requestCodeCreateFile)final ContextgetContext()final BooleanisStorageAccessGranted(String storageId)Even though storage permission has been granted via hasStoragePermission, read and write access may have not been granted yet. final UnitrequestStorageAccess(Integer requestCode, FileFullPath initialPath, StorageType expectedStorageType, String expectedBasePath)Managing files in direct storage requires root access. final UnitrequestStorageAccess(Integer requestCode, FileFullPath initialPath, StorageType expectedStorageType)Managing files in direct storage requires root access. final UnitrequestStorageAccess(Integer requestCode, FileFullPath initialPath)Managing files in direct storage requires root access. final UnitrequestStorageAccess(Integer requestCode)Managing files in direct storage requires root access. final UnitrequestStorageAccess()Managing files in direct storage requires root access. final UnitrequestFullStorageAccess()Makes your app can access direct file pathsSee Manage all files on a storage device final UnitcreateFile(String mimeType, String fileName, FileFullPath initialPath, Integer requestCode)Show interactive UI to create a file. final UnitcreateFile(String mimeType, String fileName, FileFullPath initialPath)Show interactive UI to create a file. final UnitcreateFile(String mimeType, String fileName)Show interactive UI to create a file. final UnitcreateFile(String mimeType)Show interactive UI to create a file. final UnitopenFolderPicker(Integer requestCode, FileFullPath initialPath)final UnitopenFolderPicker(Integer requestCode)final UnitopenFolderPicker()final UnitopenFilePicker(Integer requestCode, Boolean allowMultiple, FileFullPath initialPath, String filterMimeTypes)final UnitopenFilePicker(Integer requestCode, Boolean allowMultiple, String filterMimeTypes)final UnitopenFilePicker(Integer requestCode, String filterMimeTypes)final UnitopenFilePicker(String filterMimeTypes)final UnitcheckIfFileReceived(Intent intent)final UnitonActivityResult(Integer requestCode, Integer resultCode, Intent data)final UnitonSaveInstanceState(Bundle outState)final UnitonRestoreInstanceState(Bundle savedInstanceState)-
-
Method Detail
-
getStorageAccessCallback
final StorageAccessCallback getStorageAccessCallback()
-
setStorageAccessCallback
final Unit setStorageAccessCallback(StorageAccessCallback storageAccessCallback)
-
getFolderPickerCallback
final FolderPickerCallback getFolderPickerCallback()
-
setFolderPickerCallback
final Unit setFolderPickerCallback(FolderPickerCallback folderPickerCallback)
-
getFilePickerCallback
final FilePickerCallback getFilePickerCallback()
-
setFilePickerCallback
final Unit setFilePickerCallback(FilePickerCallback filePickerCallback)
-
getCreateFileCallback
final CreateFileCallback getCreateFileCallback()
-
setCreateFileCallback
final Unit setCreateFileCallback(CreateFileCallback createFileCallback)
-
getFileReceiverCallback
final FileReceiverCallback getFileReceiverCallback()
-
setFileReceiverCallback
final Unit setFileReceiverCallback(FileReceiverCallback fileReceiverCallback)
-
getRequestCodeStorageAccess
final Integer getRequestCodeStorageAccess()
-
setRequestCodeStorageAccess
final Unit setRequestCodeStorageAccess(Integer requestCodeStorageAccess)
-
getRequestCodeFolderPicker
final Integer getRequestCodeFolderPicker()
-
setRequestCodeFolderPicker
final Unit setRequestCodeFolderPicker(Integer requestCodeFolderPicker)
-
getRequestCodeFilePicker
final Integer getRequestCodeFilePicker()
-
setRequestCodeFilePicker
final Unit setRequestCodeFilePicker(Integer requestCodeFilePicker)
-
getRequestCodeCreateFile
final Integer getRequestCodeCreateFile()
-
setRequestCodeCreateFile
final Unit setRequestCodeCreateFile(Integer requestCodeCreateFile)
-
getContext
final Context getContext()
-
isStorageAccessGranted
final Boolean isStorageAccessGranted(String storageId)
Even though storage permission has been granted via hasStoragePermission, read and write access may have not been granted yet.
- Parameters:
storageId- Use PRIMARY for external storage.
-
requestStorageAccess
@RequiresApi(value = 21)@JvmOverloads() final Unit requestStorageAccess(Integer requestCode, FileFullPath initialPath, StorageType expectedStorageType, String expectedBasePath)
Managing files in direct storage requires root access. Thus we need to make sure users select root path.
- Parameters:
initialPath- only takes effect on API 30+expectedStorageType- for example, if you set StorageType.SD_CARD but the user selects StorageType.EXTERNAL, then trigger StorageAccessCallback.onRootPathNotSelected.expectedBasePath- applicable for API 30+ only, because Android 11 does not allow selecting the root path.
-
requestStorageAccess
@RequiresApi(value = 21)@JvmOverloads() final Unit requestStorageAccess(Integer requestCode, FileFullPath initialPath, StorageType expectedStorageType)
Managing files in direct storage requires root access. Thus we need to make sure users select root path.
- Parameters:
initialPath- only takes effect on API 30+expectedStorageType- for example, if you set StorageType.SD_CARD but the user selects StorageType.EXTERNAL, then trigger StorageAccessCallback.onRootPathNotSelected.
-
requestStorageAccess
@RequiresApi(value = 21)@JvmOverloads() final Unit requestStorageAccess(Integer requestCode, FileFullPath initialPath)
Managing files in direct storage requires root access. Thus we need to make sure users select root path.
- Parameters:
initialPath- only takes effect on API 30+
-
requestStorageAccess
@RequiresApi(value = 21)@JvmOverloads() final Unit requestStorageAccess(Integer requestCode)
Managing files in direct storage requires root access. Thus we need to make sure users select root path.
-
requestStorageAccess
@RequiresApi(value = 21)@JvmOverloads() final Unit requestStorageAccess()
Managing files in direct storage requires root access. Thus we need to make sure users select root path.
-
requestFullStorageAccess
@RequiresPermission(value = android.permission.MANAGE_EXTERNAL_STORAGE)@RequiresApi(value = 30) final Unit requestFullStorageAccess()
Makes your app can access direct file paths
-
createFile
@JvmOverloads() final Unit createFile(String mimeType, String fileName, FileFullPath initialPath, Integer requestCode)
Show interactive UI to create a file.
- Parameters:
initialPath- only takes effect on API 26+
-
createFile
@JvmOverloads() final Unit createFile(String mimeType, String fileName, FileFullPath initialPath)
Show interactive UI to create a file.
- Parameters:
initialPath- only takes effect on API 26+
-
createFile
@JvmOverloads() final Unit createFile(String mimeType, String fileName)
Show interactive UI to create a file.
-
createFile
@JvmOverloads() final Unit createFile(String mimeType)
Show interactive UI to create a file.
-
openFolderPicker
@JvmOverloads() final Unit openFolderPicker(Integer requestCode, FileFullPath initialPath)
- Parameters:
initialPath- only works for API 26+
-
openFolderPicker
@JvmOverloads() final Unit openFolderPicker(Integer requestCode)
-
openFolderPicker
@JvmOverloads() final Unit openFolderPicker()
-
openFilePicker
@JvmOverloads() final Unit openFilePicker(Integer requestCode, Boolean allowMultiple, FileFullPath initialPath, String filterMimeTypes)
- Parameters:
initialPath- only takes effect on API 26+
-
openFilePicker
@JvmOverloads() final Unit openFilePicker(Integer requestCode, Boolean allowMultiple, String filterMimeTypes)
-
openFilePicker
@JvmOverloads() final Unit openFilePicker(Integer requestCode, String filterMimeTypes)
-
openFilePicker
@JvmOverloads() final Unit openFilePicker(String filterMimeTypes)
-
checkIfFileReceived
final Unit checkIfFileReceived(Intent intent)
-
onActivityResult
final Unit onActivityResult(Integer requestCode, Integer resultCode, Intent data)
-
onSaveInstanceState
final Unit onSaveInstanceState(Bundle outState)
-
onRestoreInstanceState
final Unit onRestoreInstanceState(Bundle savedInstanceState)
-
-
-
-