chrome.fileSystem

Açıklama

Kullanıcının yerel dosya sisteminde oluşturma, okuma, gezinme ve yazma işlemleri için chrome.fileSystem API'sini kullanın. Bu API ile Chrome uygulamaları, kullanıcı tarafından seçilen bir konumu okuyabilir ve bu konuma yazabilir. Örneğin, bir metin düzenleyici uygulaması, yerel dokümanları okumak ve yazmak için API'yi kullanabilir. Tüm hatalar chrome.runtime.lastError aracılığıyla bildirilir.

İzinler

fileSystem

Kullanılabilirlik

Yalnızca ön plan

Türler

AcceptOption

Özellikler

  • açıklama

    dize isteğe bağlı

    Bu, seçenek için isteğe bağlı metin açıklamasıdır. Yoksa otomatik olarak bir açıklama oluşturulur.Bu açıklama genellikle geçerli uzantıların genişletilmiş bir listesini içerir (ör. "text/html" uzantısı "*.html, *.htm" olarak genişletilebilir).

  • uzantılar

    string[] isteğe bağlı

    Kabul edilecek uzantılar (ör. "jpg", "gif", "crx").

  • mimeTypes

    string[] isteğe bağlı

    Kabul edilecek MIME türleri (ör. "image/jpeg" veya "audio/*"). mimeTypes veya extensions'dan biri en az bir geçerli öğe içermelidir.

ChooseEntryOptions

Özellikler

  • kabul eder

    AcceptOption[] isteğe bağlı

    Bu dosya açıcı için isteğe bağlı kabul seçenekleri listesi. Her seçenek, son kullanıcıya benzersiz bir grup olarak sunulur.

  • acceptsAllTypes

    boolean isteğe bağlı

    accepts bağımsız değişkeninde belirtilen seçeneklere ek olarak tüm dosya türlerinin kabul edilip edilmeyeceği. Varsayılan değer true'dur. Kabul eder alanı ayarlanmamışsa veya geçerli giriş içermiyorsa bu alan her zaman doğru olarak sıfırlanır.

  • acceptsMultiple

    boolean isteğe bağlı

    Birden fazla dosyanın kabul edilip edilmeyeceği. Bu yalnızca openFile ve openWritableFile için desteklenir. Bu değer true olarak ayarlanırsa chooseEntry geri çağırma işlemi, giriş listesiyle birlikte çağrılır. Aksi takdirde tek bir girişle çağrılır.

  • suggestedName

    dize isteğe bağlı

    Kullanıcıya okuma veya yazma için varsayılan ad olarak sunulacak önerilen dosya adı. Bu işlem isteğe bağlıdır.

  • tür

    ChooseEntryType isteğe bağlı

    Gösterilecek istem türü. Varsayılan değer "openFile"dır.

ChooseEntryType

Enum

"openFile"
Kullanıcıdan mevcut bir dosyayı açmasını ister ve işlem başarılı olursa FileEntry döndürür. Chrome 31'den itibaren, uygulamanın "fileSystem" altında "write" izni varsa FileEntry yazılabilir, aksi takdirde FileEntry salt okunur olur.

"openWritableFile"
Kullanıcıdan mevcut bir dosyayı açmasını ister ve başarılı olursa yazılabilir bir FileEntry döndürür. Bu türü kullanan çağrılar, uygulamanın "fileSystem" altında "write" izni yoksa çalışma zamanı hatasıyla başarısız olur.

"saveFile"
Kullanıcıdan mevcut bir dosyayı veya yeni bir dosyayı açmasını ister ve başarılı olursa yazılabilir bir FileEntry döndürür. Bu türü kullanan çağrılar, uygulamanın "fileSystem" altında "write" izni yoksa çalışma zamanı hatasıyla başarısız olur.

"openDirectory"
Kullanıcıdan bir dizin açmasını ister ve başarılı olursa DirectoryEntry döndürür. Bu türü kullanan aramalar, uygulamanın "fileSystem" altında "directory" izni yoksa çalışma zamanı hatasıyla başarısız olur. Uygulamanın "fileSystem" altında "write" izni varsa döndürülen DirectoryEntry yazılabilir, aksi takdirde salt okunur olur. Chrome 31'deki yenilikler

RequestFileSystemOptions

Chrome 44 veya daha yeni bir sürüm

Özellikler

  • volumeId

    dize

    İstenen birimin kimliği.

  • yazılabilir

    boolean isteğe bağlı

    İstenen dosya sisteminin yazılabilir olup olmayacağı. Varsayılan değer salt okunurdur.

Volume

Chrome 44 veya daha yeni bir sürüm

Özellikler

  • volumeId

    dize

  • yazılabilir

    boolean

VolumeListChangedEvent

Chrome 44 veya daha yeni bir sürüm

Özellikler

Yöntemler

chooseEntry()

chrome.fileSystem.chooseEntry(
  options?: ChooseEntryOptions,
  callback: function,
): void

Kullanıcıdan bir dosya veya dizin seçmesini isteyin.

Parametreler

  • seçenekler

    ChooseEntryOptions isteğe bağlı

  • callback

    işlev

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

    (entry?: Entry, fileEntries?: FileEntry[]) => void

    • giriş

      Giriş isteğe bağlıdır.

    • fileEntries

      FileEntry[] isteğe bağlı

getDisplayPath()

Promise 
chrome.fileSystem.getDisplayPath(
  entry: Entry,
  callback?: function,
): Promise<string>

Bir Entry nesnesinin görüntüleme yolunu alın. Görünen yol, yerel dosya sistemindeki dosyanın veya dizinin tam yoluna dayanır ancak görüntüleme amacıyla daha okunabilir hale getirilebilir.

Parametreler

  • giriş

    Giriş

  • callback

    işlev isteğe bağlı

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

    (displayPath: string) => void

    • displayPath

      dize

İadeler

  • Promise<string>

    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.

getVolumeList()

Promise Chrome 44 veya daha yeni sürümler 
chrome.fileSystem.getVolumeList(
  callback?: function,
): Promise<Volume[] | undefined>

requestFileSystem() için kullanılabilen birimlerin listesini döndürür. "fileSystem": {"requestFileSystem"} manifest izni gereklidir. Yalnızca kiosk oturumunda çalışan kiosk uygulamalarında kullanılabilir. Hata durumunda volumes tanımlanmamış olur ve chrome.runtime.lastError ayarlanır.

Parametreler

  • callback

    işlev isteğe bağlı

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

    (volumes?: Volume[]) => void

    • ciltler

      Volume[] isteğe bağlı

İadeler

  • Promise<Volume[] | undefined>

    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.

getWritableEntry()

chrome.fileSystem.getWritableEntry(
  entry: Entry,
  callback: function,
): void

Başka bir girişten yazılabilir bir giriş alma. Uygulamanın "fileSystem" altında "write" izni yoksa bu çağrı, çalışma zamanı hatasıyla başarısız olur. Giriş bir DirectoryEntry ise uygulama "fileSystem" altında "directory" iznine sahip değilse bu çağrı başarısız olur.

Parametreler

  • giriş

    Giriş

  • callback

    işlev

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

    (entry: Entry) => void

    • giriş

      Giriş

isRestorable()

Promise 
chrome.fileSystem.isRestorable(
  id: string,
  callback?: function,
): Promise<boolean>

Uygulamanın, verilen kimliğe sahip girişi geri yükleme izni olup olmadığını döndürür.

Parametreler

  • id

    dize

  • callback

    işlev isteğe bağlı

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

    (isRestorable: boolean) => void

    • isRestorable

      boolean

İadeler

  • Promise<boolean>

    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.

isWritableEntry()

Promise 
chrome.fileSystem.isWritableEntry(
  entry: Entry,
  callback?: function,
): Promise<boolean>

Bu Giriş'in yazılabilir olup olmadığını alır.

Parametreler

  • giriş

    Giriş

  • callback

    işlev isteğe bağlı

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

    (isWritable: boolean) => void

    • isWritable

      boolean

İadeler

  • Promise<boolean>

    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 44 veya daha yeni sürümler 
chrome.fileSystem.requestFileSystem(
  options: RequestFileSystemOptions,
  callback?: function,
): Promise<FileSystem | undefined>

options.volumeId ile gösterilen bir birim için dosya sistemine erişim isteğinde bulunulduğunda. options.writable değeri true olarak ayarlanırsa dosya sistemi yazılabilir olur. Aksi takdirde salt okunur olur. writable seçeneği için manifest dosyasında "fileSystem": {"write"} izni gerekir. Yalnızca kiosk oturumunda çalışan kiosk uygulamalarında kullanılabilir. Manuel başlatılan kiosk modunda, etkin uygulama penceresinin üzerinde bir onay iletişim kutusu gösterilir. Hata durumunda fileSystem tanımlanmamış olur ve chrome.runtime.lastError ayarlanır.

Parametreler

  • callback

    işlev isteğe bağlı

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

    (fileSystem?: FileSystem) => void

    • fileSystem

      FileSystem isteğe bağlı

İadeler

  • Promise<FileSystem | undefined>

    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.

restoreEntry()

chrome.fileSystem.restoreEntry(
  id: string,
  callback: function,
): void

Geri yüklenebiliyorsa belirtilen kimliğe sahip dosya girişini döndürür. Aksi takdirde bu çağrı, çalışma zamanı hatasıyla başarısız olur.

Parametreler

  • id

    dize

  • callback

    işlev

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

    (entry: Entry) => void

    • giriş

      Giriş

retainEntry()

chrome.fileSystem.retainEntry(
  entry: Entry,
): string

Belirli bir dosya girişine tekrar erişmek için restoreEntry'ye iletilebilecek bir kimlik döndürür. Yalnızca en son kullanılan 500 giriş saklanır. Burada retainEntry ve restoreEntry çağrıları kullanım olarak kabul edilir. Uygulama, "fileSystem" altında "retainEntries" iznine sahipse girişler süresiz olarak saklanır. Aksi takdirde, girişler yalnızca uygulama çalışırken ve yeniden başlatmalar sırasında saklanır.

Parametreler

  • giriş

    Giriş

İadeler

  • dize

Etkinlikler

onVolumeListChanged

Chrome 44 veya daha yeni bir sürüm 
chrome.fileSystem.onVolumeListChanged.addListener(
  callback: function,
)

Kullanılabilir birimlerin listesi değiştiğinde çağrılır.

Parametreler