Libsoftphone/cz.acrobits.libsoftphone.filestorage/FileStorageManager

FileStorageManager

open class FileStorageManager : FileStorage, FileStorageNative, Listeners.OnSettingsChanged

FileStorage manager API - general framework for filesystem usage, it should provide any filesystem related operations in app. File system commits done by FileStorage manager are automatically respect for Scoped Storage conditions since Android Q version.

Properties

val APP_EXTERNAL: Int = 1

val BACKUP: Int = 5

val DOWNLOADS: Int = 4

val EXTERNAL: Int = 0

Types of storage

FILE_PROVIDER_AUTHORITY

val FILE_PROVIDER_AUTHORITY: String

val INTERNAL: Int = 2

val LOGGING: Int = 7

val MEDIA: Int = 0

Groups of file contents according the app use cases (could be extended in case of new logical types file system usages created)

val NOTIFICATIONS: Int = 3

val QD_ICON: Int = 6

val RECORDINGS: Int = 1

val RINGTONES: Int = 2

Functions

createCacheFile

open fun createCacheFile(@NonNull cachePath: Array<String>): File

Create empty cache file.

createPrivateFile

open fun createPrivateFile(fileName: String, contentType: Int): File

Create empty private file.

open fun createUri(@Nullable file: File): Uri

Create a new empty file and build uri for it

open fun delete(@Nullable file: File): Boolean

Delete file of directory according to :

open fun delete(fileName: String, contentType: Int, storageType: Int): Boolean

Delete file according to :

deleteDirectoryNative

open fun deleteDirectoryNative(@NonNull filePath: String): Boolean

Used from native code Delete directory with specified filepath.

deleteFileNative

open fun deleteFileNative(@NonNull filePath: String): Boolean

Used from native code Delete file with specified filepath.

deleteOnMediaStore

open fun deleteOnMediaStore(@NonNull uri: Uri): Boolean

Delete media store file according to :

getAppFilesDirectory

open fun getAppFilesDirectory(): String

getAppRootDirectory

open fun getAppRootDirectory(): String

getBaseDirectory

open fun getBaseDirectory(): String

getCacheDirectory

open fun getCacheDirectory(): String

open fun getCacheFile(@NonNull cachePath: Array<String>): File

Get a cache file with the supplied path segments.

getDownloadsDirectory

open fun getDownloadsDirectory(): String

getExpandableRecordingPath

open fun getExpandableRecordingPath(external: Boolean): String

open fun getFile(@NonNull fileName: String, contentType: Int, storageType: Int): File

Retrieve existed file from file storage according to :

open fun getFileSize(@NonNull uri: Uri): Long

getFileSizeNative

open fun getFileSizeNative(@NonNull filePath: String): Int

Used from native code Getting file size in bytes.

open fun getInputStream(uri: Uri): InputStream

Retrieve of input stream from uri

open fun getInstance(): FileStorage

getOutputStream

open fun getOutputStream(@NonNull uri: Uri): FileOutputStream

Retrieve of output stream from uri

getPrivateDataDirectory

open fun getPrivateDataDirectory(): String

getPrivateTempDirectory

open fun getPrivateTempDirectory(): String

getRecordingDirectory

open fun getRecordingDirectory(external: Boolean): String

getSharedDirectory

open fun getSharedDirectory(type: String): String

getStorageDirectory

open fun getStorageDirectory(contentType: Int, mediaType: MediaType, storageType: Int): String

Return complete filesystem path of storage directory that used by app according to :

getUploadsDirectory

open fun getUploadsDirectory(): String

open fun getUri(@Nullable file: File): Uri

Retrieve uri of existed file

getVirtualFileSize

@RequiresApi(value = 24)

open fun getVirtualFileSize(@NonNull uri: Uri): Long

open fun isEmpty(@Nullable file: File): Boolean

isUriAccessible

open fun isUriAccessible(@Nullable uri: Uri): Boolean

open fun moveToCache(@NonNull sourceFile: File, @NonNull cachePath: Array<String>): Uri

normalizeFileName

open fun normalizeFileName(@NonNull fileName: String): String

onContextInitialized

open fun onContextInitialized()

onSettingsChanged

open fun onSettingsChanged()

open fun openFileNative(@NonNull filePath: String, create: Boolean): Int

Used from native code Getting access to file by obtaining native file descriptor.

releaseAllPersistableUriPermissions

open fun releaseAllPersistableUriPermissions()

Release all persistable URI permissions that was taken by app.

releasePersistableUriPermissions

open fun releasePersistableUriPermissions(uris: List<Uri>, modeFlags: Int)

Release certain persistable URI permissions that was taken.

open fun save(@Nullable sourceUri: Uri, @Nullable targetStream: FileOutputStream): Boolean

Save provided content from provided uri to output stream of existed file.

open fun save(@NonNull bitmap: Bitmap, @NonNull fileName: String, storageType: Int): Uri

Save provided bitmap to file storage as image file.

open fun save(@NonNull file: File, contentType: Int, storageType: Int): Uri

Save provided file to file storage according to :

open fun save(@NonNull sourceUri: Uri, @NonNull fileName: String, contentType: Int, storageType: Int): Uri

Save provided content from uri to file storage according to :

open fun save(bytes: Array<Byte>, @NonNull fileName: String, contentType: Int, storageType: Int): Uri

Save provided byte array to file storage.

open fun save(@NonNull sourceStream: InputStream, @NonNull fileName: String, contentType: Int, storageType: Int): Uri

Save provided input stream data to file storage according to :

open fun saveToCache(@NonNull bitmap: Bitmap, @NonNull cachePath: Array<String>): Uri

Save content from provided bitmap to cache.

open fun saveToCache(@NonNull sourceUri: Uri, @NonNull cachePath: Array<String>): Uri

Save content from provided uri to cache.

open fun saveToCache(bytes: Array<Byte>, @NonNull cachePath: Array<String>): Uri

Save content from provided byte array to cache.

open fun saveToCache(@NonNull sourceFile: File, @NonNull cachePath: Array<String>): Uri

open fun saveToCache(@NonNull sourceStream: InputStream, @NonNull cachePath: Array<String>): Uri

saveToPrivateStorage

open fun saveToPrivateStorage(sourceUri: Uri, fileName: String, contentType: Int): Uri

Save content from provided uri to private storage.

saveVirtualFile

@RequiresApi(value = 24)

open fun saveVirtualFile(@Nullable sourceUri: Uri, @Nullable targetStream: FileOutputStream): Boolean

Save provided content from provided uri of virtual file (for example virtual files created by Google Drive) to output stream of existed file.

takePersistableUriPermission

open fun takePersistableUriPermission(uris: List<Uri>, modeFlags: Int)

Take a persistable URI permission grant that has been offered (for example for URI retrieved using SAF framework with ACTION_OPEN_DOCUMENT).