Panduan
Bagian berjudul “Panduan”Capacitor Plugin File Mengimplementasikan operasi sistem file yang sama seperti plugin File Cordova.
Kemampuan Utama
Bagian berjudul “Kemampuan Utama”requestFileSystem- Minta sistem file.resolveLocalFileSystemURL- Mengatasi URL file ke sebuah entri.getFile- Dapatkan entri file.getDirectory- Dapatkan entri direktori.
Publik API
Bagian berjudul “Publik API”| Metode | Deskripsi |
|---|---|
requestFileSystem | Minta sistem file. |
resolveLocalFileSystemURL | Resolusi URL file ke entri. |
getFile | Dapatkan entri file. |
getDirectory | Dapatkan entri direktori. |
readFile | Baca file sebagai teks atau base64. |
readAsDataURL | Baca file sebagai URL data (base64 dengan prefiks MIME). |
writeFile | Tulis data ke file. |
appendFile | Menambahkan data ke sebuah file. |
deleteFile | Tidak ada file. |
mkdir | Membuat sebuah direktori. |
rmdir | Menghapus sebuah direktori. |
readdir | Membaca isi direktori. |
stat | Mendapatkan metadata tentang sebuah file atau direktori. |
getMetadata | Mendapatkan metadata tentang sebuah file atau direktori. Alias untuk stat(). |
rename | Ubah nama atau pindahkan file atau direktori. |
move | Mengganti nama sebuah file atau direktori. Alias untuk rename(). |
copy | Menggandakan sebuah file atau direktori. |
exists | Mengganti nama sebuah file atau direktori. |
getUri | Mengecek apakah sebuah file atau direktori ada. |
truncate | Potong file menjadi ukuran tertentu. |
getDirectories | Mendapatkan semua direktori sistem file yang diketahui. |
getFreeDiskSpace | Mendapatkan ruang disk gratis dalam byte. |
addListener | Tunggu peristiwa kemajuan baca. |
addListener | Tunggu peristiwa kemajuan tulis. |
removeAllListeners | Menghapus semua pendengar acara. |
getPluginVersion | Mendapatkan versi plugin. |
checkPermissions | Periksa status izin saat ini untuk operasi file. Pada Android, ini memeriksa izin penyimpanan eksternal. Pada iOS dan web, ini selalu mengembalikan ‘diberikan’ karena tidak perlu izin khusus. |
requestPermissions | Minta izin untuk operasi file. Pada Android, ini meminta izin penyimpanan eksternal yang diperlukan untuk mengakses file di luar direktori pribadi aplikasi. Pada iOS dan web, ini selalu mengembalikan ‘diberikan’ karena tidak perlu izin khusus. |
Nilai Referensi
Judul Bagian ‘Nilai Referensi’Pakai nilai-nilai ini ketika memilih lokasi penyimpanan, menulis teks yang dikodekan, atau menghadapi kesalahan file.
Daftar Direktori
Judul Bagian “Direktori”| Nilai | Pengguna akan menemukan |
|---|---|
DOCUMENTS | File Dokumen yang Tidak Perlu Dihapus. Pada Android ini berarti direktori file aplikasi. |
DATA | Dokumen Aplikasi yang Pribadi. |
LIBRARY | Dokumen Aplikasi yang Tidak Perlu Dihapus dan Tidak Dilihat Pengguna. Pada Android ini berarti direktori file aplikasi. |
CACHE | Data Cache Sementara yang Dapat Dihapus Sistem. |
EXTERNAL | Root Penyimpanan Luar Pada Android, Seperti Kartu SD atau Penyimpanan Luar yang Dibagikan. |
EXTERNAL_STORAGE | Direktori Data Penyimpanan Luar Pada Android. |
APPLICATION | Direktori Paket Aplikasi yang Tidak Bisa Diedit. |
Kode Pengkodean
Judul Bagian “Kode Kunci”| Nilai | Gunakan |
|---|---|
utf8 | Teks UTF-8. |
ascii | Teks ASCII. |
utf16 | Teks UTF-16. |
Kode Kesalahan File
Judul Bagian “Kode Kesalahan File”| Nilai | Code | Arti |
|---|---|---|
NOT_FOUND_ERR | 1 | File atau direktori tidak ditemukan. |
SECURITY_ERR | 2 | Operasi diblokir oleh aturan keamanan atau hak istimewa. |
ABORT_ERR | 3 | Operasi dihentikan. |
NOT_READABLE_ERR | 4 | File atau direktori tidak dapat dibaca. |
ENCODING_ERR | 5 | Kode pengkodean tidak valid atau tidak didukung. |
NO_MODIFICATION_ALLOWED_ERR | 6 | Target tidak dapat diedit. |
INVALID_STATE_ERR | 7 | Objek dalam keadaan tidak valid untuk operasi. |
SYNTAX_ERR | 8 | Path atau sintaks masukan tidak valid. |
INVALID_MODIFICATION_ERR | 9 | Pertukaran yang diminta tidak valid untuk target. |
QUOTA_EXCEEDED_ERR | 10 | Kuota penyimpanan telah melebihi batas. |
TYPE_MISMATCH_ERR | 11 | Tipe nilai tidak sesuai dengan jenis yang diharapkan. |
PATH_EXISTS_ERR | 12 | Path target sudah ada. |
Sumber Kebenaran
Judul Bagian “Sumber Kebenaran”Referensi ini disinkronkan dari src/definitions.ts dalam capacitor-file.
Teruskan dari @capgo/capacitor-file
Judul Bagian “Teruskan dari @capgo/capacitor-file”Jika Anda menggunakan /capgo/capacitor-file untuk merencanakan penyimpanan dan pengelolaan file, hubungkannya dengan Menggunakan @capgo/capacitor-file untuk kemampuan asli dalam Menggunakan @capgo/capacitor-file, @capgo/capacitor-penyimpanan-data-sqlite untuk detail implementasi di @capgo/capacitor-data-storage-sqlite, Menggunakan @capgo/capacitor-data-storage-sqlite untuk kemampuan native di Menggunakan @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-uploader untuk detail implementasi di @capgo/capacitor-uploader, dan Menggunakan @capgo/capacitor-uploader untuk kemampuan native di Menggunakan @capgo/capacitor-uploader.