Method Detail

• getMimeType

   final String getMimeType()

• getInPrimaryStorage

   final Boolean getInPrimaryStorage()

• getDataDirectory

   final File getDataDirectory()

• getIsEmpty

   final Boolean getIsEmpty()

• getWritableDirs

   final Set<File> getWritableDirs()

• getStorageId

   final static String getStorageId(File $self, Context context)

  ID of this storage. For external storage, it will return PRIMARY, otherwise it is a SD Card and will return integers like 6881-2249.

• isReadOnly

   final static Boolean isReadOnly(File $self, Context context)

• isExternalStorageManager

   final static Boolean isExternalStorageManager(File $self, Context context)

• inKitkatSdCard

   final static Boolean inKitkatSdCard(File $self)

• inSameMountPointWith

   final static Boolean inSameMountPointWith(File $self, Context context, File file)

• getStorageType

   final static StorageType getStorageType(File $self, Context context)

• inSdCardStorage

   final static <ERROR CLASS> inSdCardStorage(File $self, Context context)

• inDataStorage

   final static <ERROR CLASS> inDataStorage(File $self, Context context)

• child

   final static File child(File $self, String path)

  Parameters:

  path - single file name or file path

• shouldWritable

   final static Boolean shouldWritable(File $self, Context context, Boolean requiresWriteAccess)

• takeIfWritable

   final static <ERROR CLASS> takeIfWritable(File $self, Context context, Boolean requiresWriteAccess)

• checkRequirements

   final static Boolean checkRequirements(File $self, Context context, Boolean requiresWriteAccess, Boolean considerRawFile)

• getBasePath

   final static String getBasePath(File $self, Context context)

• getRootPath

   final static String getRootPath(File $self, Context context)

• getSimplePath

   final static <ERROR CLASS> getSimplePath(File $self, Context context)

• recreateFile

   final static Boolean recreateFile(File $self)

• canModify

   final static Boolean canModify(File $self, Context context)

• isWritable

   final static Boolean isWritable(File $self, Context context)

  Use it, because File.canWrite is unreliable on Android 10. Read this issue

• autoIncrementFileName

   final static String autoIncrementFileName(File $self, String filename)

  Avoid duplicate file name. It doesn't work if you are outside Context.getExternalFilesDir and don't have full disk access for Android 10+.

• makeFile

   final static File makeFile(File $self, Context context, String name, String mimeType, CreateMode mode, FileConflictCallback<File> onConflict)

  Create file and if exists, increment file name.

  Parameters:

  onConflict - when this callback is set and mode is not CreateMode.CREATE_NEW, then the user will be asked for resolution if conflict happens

• makeFile

   final static File makeFile(File $self, Context context, String name, String mimeType, CreateMode mode)

  Create file and if exists, increment file name.

• makeFile

   final static File makeFile(File $self, Context context, String name, String mimeType)

  Create file and if exists, increment file name.

• makeFile

   final static File makeFile(File $self, Context context, String name)

  Create file and if exists, increment file name.

• makeFolder

   final static File makeFolder(File $self, Context context, String name, CreateMode mode)

  Parameters:

  name - can input MyFolder or MyFolder/SubFolder

• makeFolder

   final static File makeFolder(File $self, Context context, String name)

  Parameters:

  name - can input MyFolder or MyFolder/SubFolder

• forceDelete

   final static Boolean forceDelete(File $self, Boolean childrenOnly)

  Parameters:

  childrenOnly - true to delete the folder contents only

• forceDelete

   final static Boolean forceDelete(File $self)

• deleteEmptyFolders

   final static Boolean deleteEmptyFolders(File $self, Context context)

• moveTo

   final static File moveTo(File $self, Context context, String targetFolder, String newFileNameInTarget, FileCallback.ConflictResolution conflictResolution)

• moveTo

   final static File moveTo(File $self, Context context, String targetFolder, String newFileNameInTarget)

• moveTo

   final static File moveTo(File $self, Context context, String targetFolder)

• moveTo

   final static File moveTo(File $self, Context context, File targetFolder, String newFileNameInTarget, FileCallback.ConflictResolution conflictResolution)

  Parameters:

  conflictResolution - using FileCallback.ConflictResolution.SKIP will return null

• moveTo

   final static File moveTo(File $self, Context context, File targetFolder, String newFileNameInTarget)

• moveTo

   final static File moveTo(File $self, Context context, File targetFolder)

• getRootRawFile

   final static <ERROR CLASS> getRootRawFile(File $self, Context context, Boolean requiresWriteAccess)

• getRootRawFile

   final static <ERROR CLASS> getRootRawFile(File $self, Context context)

• createNewFileIfPossible

   final static Boolean createNewFileIfPossible(File $self)

• toDocumentFile

   final static DocumentFile toDocumentFile(File $self, Context context)

• tryCreateNewFile

   final static Boolean tryCreateNewFile(File $self)