chrome.syncFileSystem

Deskripsi

Gunakan chrome.syncFileSystem API untuk menyimpan dan menyinkronkan data di Google Drive. API ini BUKAN untuk mengakses dokumen pengguna arbitrer yang disimpan di Google Drive. Penyimpanan ini menyediakan penyimpanan yang dapat disinkronkan khusus aplikasi untuk penggunaan offline dan caching sehingga data yang sama dapat tersedia di berbagai klien. Baca Mengelola Data untuk mengetahui informasi selengkapnya tentang penggunaan API ini.

Izin

syncFileSystem

Jenis

ConflictResolutionPolicy

Enum

"last_write_win"

"manual"

FileInfo

Properti

  • action

    SyncAction opsional

    Tindakan sinkronisasi yang diambil untuk memicu peristiwa onFileStatusChanged. Nilai tindakan dapat berupa 'added', 'updated', atau 'deleted'. Hanya berlaku jika statusnya 'synced'.

  • direction

    SyncDirection opsional

    Arah sinkronisasi untuk peristiwa onFileStatusChanged. Nilai arah sinkronisasi dapat berupa 'local_to_remote' atau 'remote_to_local'. Hanya berlaku jika statusnya 'synced'.

  • fileEntry

    Entri

    fileEntry untuk file target yang statusnya telah berubah. Berisi informasi nama dan jalur file yang disinkronkan. Saat penghapusan file, informasi fileEntry akan tetap tersedia, tetapi file tidak akan ada lagi.

  • status

    FileStatus

    Status file yang dihasilkan setelah peristiwa onFileStatusChanged. Nilai status dapat berupa 'synced', 'pending', atau 'conflicting'.

FileStatus

Enum

"disinkronkan"
Tidak bertentangan dan tidak memiliki perubahan lokal yang tertunda.

"tertunda"
Memiliki satu atau beberapa perubahan lokal yang tertunda dan belum disinkronkan.

"konflik"
File berkonflik dengan versi jarak jauh dan harus diselesaikan secara manual.

FileStatusInfo

Properti

  • error

    string opsional

    Error opsional yang hanya ditampilkan jika ada masalah saat mengambil FileStatus untuk file tertentu.

  • fileEntry

    Entri

    Salah satu Entri yang awalnya diberikan ke getFileStatuses.

  • status

    FileStatus

    Nilai status dapat berupa 'synced', 'pending', atau 'conflicting'.

ServiceInfo

Properti

ServiceStatus

Enum

"menginisialisasi"
Layanan sinkronisasi sedang diinisialisasi (misalnya, memulihkan data dari database, memeriksa konektivitas, dan mengautentikasi ke layanan, dll.).

"berjalan"
Layanan sinkronisasi sudah aktif dan berjalan.

"authentication_required"
Layanan sinkronisasi tidak menyinkronkan file karena layanan jarak jauh harus diautentikasi oleh pengguna untuk melanjutkan.

"temporary_unavailable"
Layanan sinkronisasi tidak menyinkronkan file karena layanan jarak jauh (sementara) tidak tersedia karena beberapa error yang dapat dipulihkan, misalnya jaringan offline, layanan jarak jauh tidak berfungsi atau tidak dapat dijangkau, dll. Detail selengkapnya harus diberikan oleh parameter description di OnServiceInfoUpdated (yang dapat berisi detail khusus layanan).

"disabled"
Layanan sinkronisasi dinonaktifkan dan konten tidak akan pernah disinkronkan. (Misalnya, hal ini dapat terjadi saat pengguna tidak memiliki akun di layanan jarak jauh atau layanan sinkronisasi mengalami error yang tidak dapat dipulihkan.)

StorageInfo

Properti

  • quotaBytes

    angka

  • usageBytes

    angka

SyncAction

Enum

"added"

"updated"

"dihapus"

SyncDirection

Enum

"local_to_remote"

"remote_to_local"

Metode

getConflictResolutionPolicy()

Janji 
chrome.syncFileSystem.getConflictResolutionPolicy(
  callback?: function,
): Promise<ConflictResolutionPolicy>

Mendapatkan kebijakan resolusi konflik saat ini.

Parameter

Hasil

  • Chrome 117+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getFileStatus()

Janji 
chrome.syncFileSystem.getFileStatus(
  fileEntry: Entry,
  callback?: function,
): Promise<FileStatus>

Menampilkan FileStatus untuk fileEntry yang diberikan. Nilai status dapat berupa 'synced', 'pending', atau 'conflicting'. Perhatikan bahwa status 'conflicting' hanya terjadi jika kebijakan penyelesaian konflik layanan ditetapkan ke 'manual'.

Parameter

  • fileEntry

    Entri

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (status: FileStatus) => void

Hasil

  • Promise<FileStatus>

    Chrome 117+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getFileStatuses()

Janji 
chrome.syncFileSystem.getFileStatuses(
  fileEntries: object[],
  callback?: function,
): Promise<FileStatusInfo[]>

Menampilkan setiap FileStatus untuk array fileEntry tertentu. Biasanya dipanggil dengan hasil dari dirReader.readEntries().

Parameter

  • fileEntries

    object[]

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (status: FileStatusInfo[]) => void

Hasil

  • Promise<FileStatusInfo[]>

    Chrome 117+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getServiceStatus()

Janji 
chrome.syncFileSystem.getServiceStatus(
  callback?: function,
): Promise<ServiceStatus>

Menampilkan status backend sinkronisasi saat ini.

Parameter

Hasil

  • Promise<ServiceStatus>

    Chrome 117+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getUsageAndQuota()

Janji 
chrome.syncFileSystem.getUsageAndQuota(
  fileSystem: DOMFileSystem,
  callback?: function,
): Promise<StorageInfo>

Menampilkan penggunaan dan kuota saat ini dalam byte untuk penyimpanan file 'syncable' untuk aplikasi.

Parameter

  • fileSystem

    DOMFileSystem

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (info: StorageInfo) => void

Hasil

  • Promise<StorageInfo>

    Chrome 117+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

requestFileSystem()

Janji 
chrome.syncFileSystem.requestFileSystem(
  callback?: function,
): Promise<DOMFileSystem>

Menampilkan sistem file yang dapat disinkronkan yang didukung oleh Google Drive. Instance DOMFileSystem yang ditampilkan dapat dioperasikan dengan cara yang sama seperti sistem file Sementara dan Persisten (lihat http://dev.w3.org/2009/dap/file-system/file-dir-sys.html).

Memanggil fungsi ini beberapa kali dari aplikasi yang sama akan menampilkan handle yang sama ke sistem file yang sama.

Perhatikan bahwa panggilan ini dapat gagal. Misalnya, jika pengguna tidak login ke Chrome atau jika tidak ada operasi jaringan. Untuk menangani error ini, penting untuk memeriksa chrome.runtime.lastError dalam callback.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

Hasil

  • Promise<DOMFileSystem>

    Chrome 117+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

setConflictResolutionPolicy()

Janji 
chrome.syncFileSystem.setConflictResolutionPolicy(
  policy: ConflictResolutionPolicy,
  callback?: function,
): Promise<void>

Menetapkan kebijakan penyelesaian konflik default untuk penyimpanan file 'syncable' aplikasi. Secara default, kebijakan ini ditetapkan ke 'last_write_win'. Jika kebijakan resolusi konflik disetel ke 'last_write_win', konflik untuk file yang ada akan otomatis diselesaikan pada saat file diperbarui berikutnya. callback dapat diberikan secara opsional untuk mengetahui apakah permintaan berhasil atau tidak.

Parameter

Hasil

  • Promise<void>

    Chrome 117+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

Acara

onFileStatusChanged

chrome.syncFileSystem.onFileStatusChanged.addListener(
  callback: function,
)

Dipicu saat file telah diperbarui oleh layanan sinkronisasi latar belakang.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (detail: FileInfo) => void

onServiceStatusChanged

chrome.syncFileSystem.onServiceStatusChanged.addListener(
  callback: function,
)

Diaktifkan saat terjadi error atau perubahan status lainnya di backend sinkronisasi (misalnya, saat sinkronisasi dinonaktifkan sementara karena error jaringan atau autentikasi).

Parameter