chrome.syncFileSystem

Açıklama

Google Drive'daki verileri kaydetmek ve senkronize etmek için chrome.syncFileSystem API'yi kullanın. Bu API, Google Drive'da depolanan rastgele kullanıcı dokümanlarına erişmek için KULLANILMAZ. Aynı verilerin farklı istemcilerde kullanılabilmesi için çevrimdışı ve önbelleğe alma kullanımı için uygulamaya özel senkronize edilebilir depolama alanı sağlar. Bu API'yi kullanma hakkında daha fazla bilgi için Verileri Yönetme başlıklı makaleyi inceleyin.

İzinler

syncFileSystem

Türler

ConflictResolutionPolicy

Enum

"last_write_win"

"manual"

FileInfo

Özellikler

  • işlem

    SyncAction isteğe bağlı

    onFileStatusChanged etkinliğini tetiklemek için gerçekleştirilen senkronizasyon işlemi. İşlem değeri 'added', 'updated' veya 'deleted' olabilir. Yalnızca durum 'synced' ise geçerlidir.

  • direction

    SyncDirection isteğe bağlı

    onFileStatusChanged etkinliğinin senkronizasyon yönü. Senkronizasyon yönü değeri 'local_to_remote' veya 'remote_to_local' olabilir. Yalnızca durum 'synced' ise geçerlidir.

  • fileEntry

    Giriş

    Durumu değişen hedef dosya için fileEntry. Senkronize edilen dosyanın adını ve yol bilgilerini içerir. Dosya silindiğinde fileEntry bilgileri kullanılmaya devam eder ancak dosya artık mevcut olmaz.

  • durum

    FileStatus

    onFileStatusChanged etkinliğinden sonraki dosya durumu. Durum değeri 'synced', 'pending' veya 'conflicting' olabilir.

FileStatus

Enum

"senkronize edildi"
Çakışmıyor ve bekleyen yerel değişiklik yok.

"beklemede"
Senkronize edilmemiş bir veya daha fazla bekleyen yerel değişiklik var.

"conflicting"
Dosya, uzak sürümle çakışıyor ve manuel olarak çözülmesi gerekiyor.

FileStatusInfo

Özellikler

  • hata

    dize isteğe bağlı

    Yalnızca belirtilen dosyanın FileStatus'u alınırken bir sorun oluştuysa döndürülen isteğe bağlı hata.

  • fileEntry

    Giriş

    getFileStatuses için başlangıçta verilen girişlerden biri.

  • durum

    FileStatus

    Durum değeri 'synced', 'pending' veya 'conflicting' olabilir.

ServiceInfo

Özellikler

ServiceStatus

Enum

"başlatılıyor"
Senkronizasyon hizmeti başlatılıyor (ör. veriler veritabanından geri yükleniyor, bağlantı kontrol ediliyor ve hizmette kimlik doğrulanıyor).

"running"
Senkronizasyon hizmeti çalışıyor.

"authentication_required"
Uzak hizmetin devam etmek için kullanıcı tarafından kimliğinin doğrulanması gerektiğinden senkronizasyon hizmeti dosyaları senkronize etmiyor.

"temporary_unavailable"
Uzak hizmet, ağın çevrimdışı olması, uzak hizmetin kapalı olması veya ulaşılamaması gibi bazı kurtarılabilir hatalar nedeniyle (geçici olarak) kullanılamadığından senkronizasyon hizmeti dosyaları senkronize etmiyor. OnServiceInfoUpdated'deki description parametresiyle daha fazla ayrıntı verilmelidir (hizmete özel ayrıntılar içerebilir).

"disabled"
Senkronizasyon hizmeti devre dışı bırakıldığından içerik hiçbir zaman senkronize edilmez. (Örneğin, bu durum, kullanıcının uzak hizmette hesabı olmadığında veya senkronizasyon hizmetinde kurtarılamayan bir hata oluştuğunda ortaya çıkabilir.)

StorageInfo

Özellikler

  • quotaBytes

    sayı

  • usageBytes

    sayı

SyncAction

Enum

"added"

"updated"

"deleted"

SyncDirection

Enum

"local_to_remote"

"remote_to_local"

Yöntemler

getConflictResolutionPolicy()

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

Mevcut çakışma çözümü politikasını alır.

Parametreler

İadeler

  • Chrome 117 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getFileStatus()

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

Belirtilen fileEntry için FileStatus değerini döndürür. Durum değeri 'synced', 'pending' veya 'conflicting' olabilir. 'conflicting' durumunun yalnızca hizmetin çakışma çözümü politikası 'manual' olarak ayarlandığında gerçekleştiğini unutmayın.

Parametreler

  • fileEntry

    Giriş

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (status: FileStatus) => void

İadeler

  • Promise<FileStatus>

    Chrome 117 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getFileStatuses()

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

Belirtilen fileEntry dizisi için her bir FileStatus değerini döndürür. Genellikle dirReader.readEntries() işlevinin sonucuyla birlikte çağrılır.

Parametreler

  • fileEntries

    object[]

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (status: FileStatusInfo[]) => void

İadeler

  • Promise<FileStatusInfo[]>

    Chrome 117 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getServiceStatus()

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

Geçerli senkronizasyon arka uç durumunu döndürür.

Parametreler

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (status: ServiceStatus) => void

İadeler

  • Promise<ServiceStatus>

    Chrome 117 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getUsageAndQuota()

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

Uygulamanın 'syncable' dosya depolama alanının bayt cinsinden mevcut kullanımını ve kotasını döndürür.

Parametreler

  • fileSystem

    DOMFileSystem

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (info: StorageInfo) => void

İadeler

  • Promise<StorageInfo>

    Chrome 117 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

requestFileSystem()

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

Google Drive tarafından desteklenen, senkronize edilebilir bir dosya sistemi döndürür. Döndürülen DOMFileSystem örneği, Geçici ve Kalıcı dosya sistemleriyle aynı şekilde kullanılabilir (bkz. http://dev.w3.org/2009/dap/file-system/file-dir-sys.html).

Aynı uygulamadan bu işlevi birden çok kez çağırmak, aynı dosya sistemine aynı tanıtıcıyı döndürür.

Bu aramanın başarısız olabileceğini unutmayın. Örneğin, kullanıcı Chrome'da oturum açmamışsa veya ağ işlemi yoksa. Bu hataları işlemek için geri çağırma işlevinde chrome.runtime.lastError'un kontrol edilmesi önemlidir.

Parametreler

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

İadeler

  • Promise<DOMFileSystem>

    Chrome 117 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

setConflictResolutionPolicy()

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

Uygulamanın 'syncable' dosya depolama alanı için varsayılan çakışma çözümü politikasını ayarlar. Varsayılan olarak 'last_write_win' olarak ayarlanır. Çakışma çözümleme politikası 'last_write_win' olarak ayarlandığında, mevcut dosyalarla ilgili çakışmalar dosya bir sonraki güncellemede otomatik olarak çözülür. İsteğin başarılı olup olmadığını öğrenmek için callback isteğe bağlı olarak verilebilir.

Parametreler

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    () => void

İadeler

  • Promise<void>

    Chrome 117 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

Etkinlikler

onFileStatusChanged

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

Bir dosya arka plan senkronizasyon hizmeti tarafından güncellendiğinde tetiklenir.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (detail: FileInfo) => void

onServiceStatusChanged

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

Senkronizasyon arka ucunda bir hata oluştuğunda veya başka bir durum değişikliği olduğunda (örneğin, ağ veya kimlik doğrulama hatası nedeniyle senkronizasyon geçici olarak devre dışı bırakıldığında) tetiklenir.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (detail: ServiceInfo) => void