chrome.fileSystem

Açıklama

Kullanıcının yerel dosya sistemini oluşturmak, okumak, gezinmek ve yazmak için chrome.fileSystem API'yi kullanın. Bu API ile Chrome Uygulamaları, kullanıcı tarafından seçilen bir konuma okuma ve yazma işlemi yapabilir. Ö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

    string isteğe bağlı

    Bu, ilgili seçeneğin isteğe bağlı metin açıklamasıdır. Mevcut değilse 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", "*.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 öğelerinden biri en az bir geçerli öğe içermelidir.

ChooseEntryOptions

Özellikler

  • kabul edilir

    AcceptOption[] isteğe bağlı

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

  • acceptsAllTypes

    boole isteğe bağlı

    Kabul edilenler 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 edilenler alanı ayarlanmazsa veya geçerli giriş içermiyorsa bu değer her zaman "true" olarak sıfırlanır.

  • acceptsMultiple

    boole isteğe bağlı

    Birden fazla dosyanın kabul edilip edilmeyeceği. Bu yalnızca openFile ve openWritableFile için desteklenir. Bu değer doğru olarak ayarlanırsa chooseEntry geri çağırma işlevi bir giriş listesiyle çağrılır. Aksi takdirde tek bir Entry ile çağrılır.

  • suggestedName

    string isteğe bağlı

    Kullanıcıya varsayılan kaydetme adı olarak sunulacak önerilen dosya adı. Bu isteğe bağlıdır ve yalnızca "saveFile" için geçerlidir.

  • tür

    ChooseEntryType isteğe bağlı

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

ChooseEntryType

Enum

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

"openWritableFile"
Kullanıcıdan mevcut bir dosyayı açmasını ister ve işlem başarılı olursa yazılabilir bir FileEntry döndürür. Uygulamanın "fileSystem" altında "write" izni yoksa bu türü kullanan çağrılar ç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. Uygulamanın "fileSystem" altında "write" izni yoksa bu türü kullanan çağrılar ç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 bir DirectoryEntry döndürür. Uygulamanın "fileSystem" altında "directory" izni yoksa bu türü kullanan çağrılar ç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 olur, aksi takdirde salt okunur olur. Chrome 31'deki yenilikler

RequestFileSystemOptions

Chrome 44+

Özellikler

  • volumeId

    dize

    İstenen birimin kimliği.

  • yazılabilir

    boole isteğe bağlı

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

Volume

Chrome 44+

Özellikler

  • volumeId

    dize

  • yazılabilir

    boole

VolumeListChangedEvent

Chrome 44+

Ö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ı

    • fileEntries

      FileEntry[] isteğe bağlı

getDisplayPath()

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

Bir Entry nesnesinin görünen yolunu alma. Görüntüleme yolu, yerel dosya sistemindeki dosya veya dizinin tam yolunu temel alır ancak görüntüleme amacıyla daha okunabilir hale getirilebilir.

Parametreler

  • giriş

    Giriş

  • callback

    function 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

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

getVolumeList()

Promise Chrome 44+ 
chrome.fileSystem.getVolumeList(
  callback?: function,
): Promise<Volume[] | undefined>

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

Parametreler

  • callback

    function 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

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

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 uygulamanın "fileSystem" altında "directory" izni yoksa 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()

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

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

Parametreler

  • id

    dize

  • callback

    function isteğe bağlı

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

    (isRestorable: boolean) => void

    • isRestorable

      boole

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

isWritableEntry()

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

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

Parametreler

  • giriş

    Giriş

  • callback

    function isteğe bağlı

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

    (isWritable: boolean) => void

    • isWritable

      boole

İadeler

  • Promise<boolean>

    Chrome 117 ve sonraki sürümler

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

requestFileSystem()

Promise Chrome 44+ 
chrome.fileSystem.requestFileSystem(
  options: RequestFileSystemOptions,
  callback?: function,
): Promise<FileSystem | undefined>

options.volumeId ile temsil edilen bir birim için dosya sistemine erişim ister. options.writable, Doğru değerine ayarlanırsa dosya sistemi yazılabilir olur. Aksi takdirde salt okunur olur. writable seçeneği, manifest dosyasında "fileSystem": {"write"} iznini gerektirir. Yalnızca kiosk oturumunda çalışan kiosk uygulamaları tarafından kullanılabilir. Manuel başlatılan kiosk modunda, etkin uygulama penceresinin üstünde bir onay iletişim kutusu gösterilir. Hata durumunda fileSystem tanımlanmaz ve chrome.runtime.lastError ayarlanır.

Parametreler

  • callback

    function 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

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

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 yeniden erişim elde etmek için restoreEntry'ye iletilebilecek bir kimlik döndürür. Yalnızca en son kullanılan 500 giriş saklanır. retainEntry ve restoreEntry çağrıları kullanım olarak sayılır. Uygulamanın "fileSystem" altında "retainEntries" izni varsa girişler süresiz olarak saklanır. Aksi takdirde, girişler yalnızca uygulama çalışırken ve yeniden başlatma işlemleri sırasında saklanır.

Parametreler

  • giriş

    Giriş

İadeler

  • dize

Etkinlikler

onVolumeListChanged

Chrome 44+ 
chrome.fileSystem.onVolumeListChanged.addListener(
  callback: function,
)

Mevcut birimlerin listesi değiştirildiğinde çağrılır.

Parametreler