@capgo/capacitor-file
Ikhtisar
Bagian berjudul “Ringkasan”Plugin sistem file lengkap untuk membaca, menulis, dan mengelola file serta direktori
Mulai dengan requestFileSystem() dan metode inti lainnya yang tercantum di bawah ini.
Dukungan platform
Bagian berjudul “Dukungan platform”| Platform | Dukungan | Catatan |
|---|---|---|
| iOS | Ya | Native |
| Android | Ya | Native |
| Web | Ya | API penyimpanan browser |
Kemampuan Utama
Bagian berjudul “Kemampuan Utama”requestFileSystem- Request file system.resolveLocalFileSystemURL- Resolve URL file ke entry.getFile- Ambil file entry.getDirectory- Dapatkan entri direktori.
API Publik
Bagian berjudul “Public API”| Metode | Deskripsi |
|---|---|
requestFileSystem | Meminta file system. |
resolveLocalFileSystemURL | Me-resolve URL file menjadi entry. |
getFile | Mendapatkan entry file. |
getDirectory | Dapatkan entri direktori. |
readFile | Baca file sebagai teks atau base64. |
readAsDataURL | Baca file sebagai data URL (base64 dengan prefix MIME type). |
writeFile | Menulis data ke dalam file. |
appendFile | Tambahkan data ke file. |
deleteFile | Hapus file. |
mkdir | Buat direktori. |
rmdir | Hapus direktori. |
readdir | Baca isi direktori. |
stat | Dapatkan metadata file atau direktori. |
getMetadata | Dapatkan metadata file atau direktori. Alias untuk stat(). |
rename | Ubah nama atau pindahkan file atau direktori. |
move | Pindahkan file atau direktori. Alias untuk rename(). |
copy | Salin file atau direktori. |
exists | Cek apakah file atau direktori ada. |
getUri | Dapatkan URI file. |
truncate | Potong file ke ukuran tertentu. |
getDirectories | Dapatkan semua direktori file system yang diketahui. |
getFreeDiskSpace | Dapatkan sisa ruang disk dalam byte. |
addListener | Pantau event progress pembacaan. |
addListener | Pantau event progress penulisan. |
removeAllListeners | Hapus semua event listener. |
getPluginVersion | Dapatkan versi plugin. |
checkPermissions | Cek 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. |
requestPermissions | Minta 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. |
Nilai Referensi
Bagian berjudul “Nilai Referensi”Gunakan nilai ini saat memilih lokasi penyimpanan, menulis teks terenkode, atau menangani error file.
Direktori
Bagian berjudul “Direktori”| Nilai | Pengguna akan menemukan |
|---|---|
DOCUMENTS | Dokumen persisten yang terlihat oleh pengguna. Di Android, ini dipetakan ke direktori file aplikasi. |
DATA | Data aplikasi privat yang persisten. |
LIBRARY | Data aplikasi persisten yang tidak terlihat oleh pengguna. Di Android, ini dipetakan ke direktori file aplikasi. |
CACHE | Data cache sementara yang dapat dihapus oleh OS. |
EXTERNAL | Root penyimpanan eksternal Android, seperti kartu SD atau penyimpanan eksternal bersama. |
EXTERNAL_STORAGE | Direktori data penyimpanan eksternal Android. |
APPLICATION | Direktori bundle aplikasi atau aset yang bersifat read-only. |
Encoding
Bagian berjudul “Encodings”| Nilai | Gunakan |
|---|---|
utf8 | Teks UTF-8. |
ascii | Teks ASCII. |
utf16 | Teks UTF-16. |
Kode Error File
Bagian berjudul “Kode Error File”| Nilai | Code | Arti |
|---|---|---|
NOT_FOUND_ERR | 1 | File atau direktori tidak ditemukan. |
SECURITY_ERR | 2 | Operasi diblokir oleh aturan keamanan atau izin. |
ABORT_ERR | 3 | Operasi dibatalkan. |
NOT_READABLE_ERR | 4 | File atau direktori tidak dapat dibaca. |
ENCODING_ERR | 5 | Encoding tidak valid atau tidak didukung. |
NO_MODIFICATION_ALLOWED_ERR | 6 | Target tidak dapat dimodifikasi. |
INVALID_STATE_ERR | 7 | Objek berada dalam status yang tidak valid untuk operasi ini. |
SYNTAX_ERR | 8 | Sintaks path atau input tidak valid. |
INVALID_MODIFICATION_ERR | 9 | Perubahan yang diminta tidak valid untuk target. |
QUOTA_EXCEEDED_ERR | 10 | Kuota penyimpanan terlampaui. |
TYPE_MISMATCH_ERR | 11 | Tipe nilai tidak sesuai dengan tipe yang diharapkan. |
PATH_EXISTS_ERR | 12 | Path target sudah ada. |
Sumber Kebenaran
Bagian berjudul “Sumber Kebenaran”Referensi ini disinkronkan dari src/definitions.ts di capacitor-file.
Lanjutkan dari @capgo/capacitor-file
Bagian berjudul “Lanjutkan dari @capgo/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.