Panduan
Cara menggunakan File di Capacitor
Menggunakan @capgo/capacitor-file
Capacitor Plugin File Melaksanakan operasi sistem file yang sama seperti plugin File Cordova.
Pasang
bun add @capgo/capacitor-file
bunx cap sync
bunx cap sync Menggandakan kode native code plugin ke proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.
Impor
import { CapacitorFile } from '@capgo/capacitor-file';
Lihat API secara singkat
| 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 MIME type prefix). |
writeFile |
Tulis data ke file. |
appendFile |
Tambahkan data ke file. |
deleteFile |
Hapus file. |
mkdir |
Buat direktori. |
rmdir |
Hapus 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 sebuah file atau direktori. |
move |
Mempindahkan sebuah file atau direktori. Alias untuk rename(). |
copy |
Menggandakan sebuah file atau direktori. |
exists |
Mengecek apakah sebuah file atau direktori ada. |
getUri |
Mendapatkan URI untuk sebuah file. |
truncate |
Mengurangi ukuran file hingga ukuran yang ditentukan. |
getDirectories |
Mendapatkan semua direktori sistem file yang diketahui. |
getFreeDiskSpace |
Mendapatkan ruang disk gratis dalam byte. |
checkPermissions |
Mengecek status izin saat ini untuk operasi file. Pada Android, ini mengecek izin penyimpanan eksternal. Pada iOS dan web, ini selalu mengembalikan 'granted' 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 ada izin khusus yang diperlukan. |
Contoh
requestFileSystem()
Minta sistem file.
import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';
const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);
resolveLocalFileSystemURL()
Mengubah URL file menjadi entri.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);
getFile()
Mengambil entri file.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);
getDirectory()
Mengambil entri direktori.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);
readFile()
Membaca file sebagai teks atau base64.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);
readAsDataURL()
Membaca file sebagai URL data (base64 dengan prefiks MIME).
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);
Tabel di atas menampilkan 24 metode inti. Pembantu pendengar dan versi, serta kontrak lengkap setiap metode, terdokumentasi di GitHub repository.
Mendengarkan event
addListener mengembalikan tanggung jawab. Panggil handle.remove() ketika layar dihapus, atau CapacitorFile.removeAllListeners() untuk membersihkan setiap pendengar.
Referensi lengkap
Teruskan dari Menggunakan @capgo/capacitor-file
Teruskan dari Menggunakan @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-file Menggunakan @capgo/capacitor-file Untuk merencanakan penyimpanan dan pengelolaan file, hubungkannya dengan @capgo/capacitor-file Untuk detail implementasi di @capgo/capacitor-file, Mulai Menggunakan untuk detail implementasi di Mulai, @capgo/capacitor-penyimpanan-data-sqlite untuk detail implementasi di @capgo/capacitor-penyimpanan-data-sqlite, Menggunakan @capgo/capacitor-penyimpanan-data-sqlite untuk kemampuan native di Menggunakan @capgo/capacitor-penyimpanan-data-sqlite, dan @capgo/capacitor-uploader untuk detail implementasi di @capgo/capacitor-uploader.