Langsung ke konten

@capgo/capacitor-file

Plugin sistem file lengkap untuk membaca, menulis, dan mengelola file serta direktori

Plugin sistem file lengkap untuk membaca, menulis, dan mengelola file serta direktori

Mulai dengan requestFileSystem() dan metode inti lainnya yang tercantum di bawah ini.

PlatformDukunganCatatan
iOSYaNative
AndroidYaNative
WebYaAPI penyimpanan browser
  • requestFileSystem - Request file system.
  • resolveLocalFileSystemURL - Resolve URL file ke entry.
  • getFile - Ambil file entry.
  • getDirectory - Dapatkan entri direktori.
MetodeDeskripsi
requestFileSystemMeminta file system.
resolveLocalFileSystemURLMe-resolve URL file menjadi entry.
getFileMendapatkan entry file.
getDirectoryDapatkan entri direktori.
readFileBaca file sebagai teks atau base64.
readAsDataURLBaca file sebagai data URL (base64 dengan prefix MIME type).
writeFileMenulis data ke dalam file.
appendFileTambahkan data ke file.
deleteFileHapus file.
mkdirBuat direktori.
rmdirHapus direktori.
readdirBaca isi direktori.
statDapatkan metadata file atau direktori.
getMetadataDapatkan metadata file atau direktori. Alias untuk stat().
renameUbah nama atau pindahkan file atau direktori.
movePindahkan file atau direktori. Alias untuk rename().
copySalin file atau direktori.
existsCek apakah file atau direktori ada.
getUriDapatkan URI file.
truncatePotong file ke ukuran tertentu.
getDirectoriesDapatkan semua direktori file system yang diketahui.
getFreeDiskSpaceDapatkan sisa ruang disk dalam byte.
addListenerPantau event progress pembacaan.
addListenerPantau event progress penulisan.
removeAllListenersHapus semua event listener.
getPluginVersionDapatkan versi plugin.
checkPermissionsCek status izin operasi file saat ini. Di Android, ini mengecek izin storage eksternal. Di iOS dan web, ini selalu mengembalikan ‘granted’ karena tidak butuh izin khusus.
requestPermissionsMinta izin operasi file. Di Android, ini meminta izin storage eksternal untuk mengakses file di luar direktori privat aplikasi. Di iOS dan web, ini selalu mengembalikan ‘granted’ karena tidak butuh izin khusus.

Gunakan nilai ini saat memilih lokasi penyimpanan, menulis teks terenkode, atau menangani error file.

NilaiPengguna akan menemukan
DOCUMENTSDokumen persisten yang terlihat oleh pengguna. Di Android, ini dipetakan ke direktori file aplikasi.
DATAData aplikasi privat yang persisten.
LIBRARYData aplikasi persisten yang tidak terlihat oleh pengguna. Di Android, ini dipetakan ke direktori file aplikasi.
CACHEData cache sementara yang dapat dihapus oleh OS.
EXTERNALRoot penyimpanan eksternal Android, seperti kartu SD atau penyimpanan eksternal bersama.
EXTERNAL_STORAGEDirektori data penyimpanan eksternal Android.
APPLICATIONDirektori bundle aplikasi atau aset yang bersifat read-only.
NilaiGunakan
utf8Teks UTF-8.
asciiTeks ASCII.
utf16Teks UTF-16.
NilaiCodeArti
NOT_FOUND_ERR1File atau direktori tidak ditemukan.
SECURITY_ERR2Operasi diblokir oleh aturan keamanan atau izin.
ABORT_ERR3Operasi dibatalkan.
NOT_READABLE_ERR4File atau direktori tidak dapat dibaca.
ENCODING_ERR5Encoding tidak valid atau tidak didukung.
NO_MODIFICATION_ALLOWED_ERR6Target tidak dapat dimodifikasi.
INVALID_STATE_ERR7Objek berada dalam status yang tidak valid untuk operasi ini.
SYNTAX_ERR8Sintaks path atau input tidak valid.
INVALID_MODIFICATION_ERR9Perubahan yang diminta tidak valid untuk target.
QUOTA_EXCEEDED_ERR10Kuota penyimpanan terlampaui.
TYPE_MISMATCH_ERR11Tipe nilai tidak sesuai dengan tipe yang diharapkan.
PATH_EXISTS_ERR12Path target sudah ada.

Referensi ini disinkronkan dari src/definitions.ts di capacitor-file.

Jika Anda menggunakan @capgo/capacitor-file untuk merencanakan penyimpanan dan penanganan file, hubungkan dengan Menggunakan @capgo/capacitor-file untuk kapabilitas native saat menggunakan @capgo/capacitor-file, @capgo/capacitor-data-storage-sqlite untuk detail implementasi di @capgo/capacitor-data-storage-sqlite, Menggunakan @capgo/capacitor-data-storage-sqlite untuk kapabilitas native di Menggunakan @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-uploader untuk detail implementasi di @capgo/capacitor-uploader, dan Menggunakan @capgo/capacitor-uploader untuk kapabilitas native saat menggunakan @capgo/capacitor-uploader.