chrome.fileSystem

Beschreibung

Mit der chrome.fileSystem API können Sie Daten im lokalen Dateisystem des Nutzers erstellen, lesen, darin navigieren und schreiben. Mit dieser API können Chrome-Apps Daten an einem vom Nutzer ausgewählten Speicherort lesen und darin schreiben. Beispielsweise kann eine Texteditor-Anwendung die API verwenden, um lokale Dokumente zu lesen und zu schreiben. Alle Fehler werden über „chrome.runtime.lastError“ benachrichtigt.

Berechtigungen

fileSystem

Verfügbarkeit

Nur Vordergrund

Typen

AcceptOption

Attribute

  • Beschreibung

    String optional

    Dies ist die optionale Textbeschreibung für diese Option. Falls nicht vorhanden, wird automatisch eine Beschreibung generiert.Sie enthält in der Regel eine erweiterte Liste gültiger Erweiterungen. Beispielsweise kann „text/html“ zu „*.html, *.htm“ erweitert werden.

  • extensions

    string[] optional

    Zulässige Erweiterungen, z.B. „jpg“, „gif“ oder „crx“.

  • mimeTypes

    string[] optional

    Zulässige MIME-Typen, z.B. „image/jpeg“ oder „audio/*“. Einer der MIME-Typen oder Erweiterungen muss mindestens ein gültiges Element enthalten.

ChooseEntryOptions

Attribute

  • akzeptiert

    AcceptOption[] optional

    Die optionale Liste von Annahmeoptionen für diesen Dateiöffner. Jede Option wird dem Endnutzer als eindeutige Gruppe präsentiert.

  • acceptsAllTypes

    Boolescher Wert optional

    Gibt an, ob zusätzlich zu den im Accept-Argument angegebenen Optionen alle Dateitypen akzeptiert werden sollen. Die Standardeinstellung ist "true". Wenn das Feld für die Annahme nicht festgelegt ist oder keine gültigen Einträge enthält, wird der Wert immer auf „true“ zurückgesetzt.

  • acceptsMultiple

    Boolescher Wert optional

    Gibt an, ob mehrere Dateien akzeptiert werden sollen. Dies wird nur für openFile und openWritableFile unterstützt. Der Callback für selectEntry wird mit einer Liste von Einträgen aufgerufen, wenn dieser Wert auf "true" gesetzt ist. Andernfalls wird sie mit einem einzelnen Eintrag aufgerufen.

  • suggestedName

    String optional

    Der vorgeschlagene Dateiname, der dem Nutzer als Standardname zum Lesen oder Schreiben angezeigt wird. Dies ist optional.

  • Typ

    ChooseEntryType optional

    Typ der anzuzeigenden Aufforderung. Der Standardwert ist „openFile“.

ChooseEntryType

Enum

"openFile"
Fordert den Nutzer auf, eine vorhandene Datei zu öffnen, und gibt bei Erfolg einen FileEntry zurück. Ab Chrome 31 ist „FileEntry“ beschreibbar, wenn die Anwendung unter „fileSystem“ eine Schreibberechtigung hat. Andernfalls ist FileEntry schreibgeschützt.

"openWritableFile"
Fordert den Nutzer auf, eine vorhandene Datei zu öffnen, und gibt bei Erfolg einen beschreibbaren FileEntry zurück. Aufrufe mit diesem Typ schlagen fehl und es wird ein Laufzeitfehler ausgegeben, wenn die Anwendung unter „fileSystem“ keine Schreibberechtigung hat.

"saveFile"
Fordert den Nutzer auf, eine vorhandene oder neue Datei zu öffnen, und gibt bei Erfolg einen beschreibbaren FileEntry zurück. Aufrufe mit diesem Typ schlagen fehl und es wird ein Laufzeitfehler ausgegeben, wenn die Anwendung unter „fileSystem“ keine Schreibberechtigung hat.

"openDirectory"
Fordert den Nutzer auf, ein Verzeichnis zu öffnen, und gibt bei Erfolg einen DirectoryEntry zurück. Aufrufe mit diesem Typ schlagen fehl und es wird ein Laufzeitfehler ausgegeben, wenn die Anwendung nicht über die Berechtigung „directory“ unter „fileSystem“ verfügt. Wenn die Anwendung unter "fileSystem" über eine Schreibberechtigung verfügt, ist der zurückgegebene DirectoryEntry beschreibbar. Andernfalls ist er schreibgeschützt. Neu in Chrome 31.

RequestFileSystemOptions

Chrome 44 und höher

Attribute

  • volumeId

    String

    Die ID des angeforderten Volumes.

  • Bearbeitbar

    Boolescher Wert optional

    Gibt an, ob das angeforderte Dateisystem beschreibbar sein soll. Die Standardeinstellung ist schreibgeschützt.

Volume

Chrome 44 und höher

Attribute

  • volumeId

    String

  • Bearbeitbar

    boolean

VolumeListChangedEvent

Chrome 44 und höher

Attribute

Methoden

chooseEntry()

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

Bitten Sie den Nutzer, eine Datei oder ein Verzeichnis auszuwählen.

Parameters

  • Optionen

    ChooseEntryOptions optional

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

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

    • Eintrag

      Eintrag optional

    • fileEntries

      FileEntry[] optional

getDisplayPath()

Versprechen 
chrome.fileSystem.getDisplayPath(
  entry: Entry,
  callback?: function,
)

Ruft den angezeigten Pfad eines Eintragsobjekts ab. Der angezeigte Pfad basiert auf dem vollständigen Pfad der Datei oder des Verzeichnisses im lokalen Dateisystem, wird aber möglicherweise zu Anzeigezwecken lesbarer.

Parameters

  • Eintrag

    Eintrag

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (displayPath: string)=>void

    • displayPath

      String

Rückgaben

  • Versprechen<string>

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.

getVolumeList()

Versprechen Chrome 44 oder höher 
chrome.fileSystem.getVolumeList(
  callback?: function,
)

Gibt eine Liste der für requestFileSystem() verfügbaren Volumes zurück. Die Manifestberechtigung „"fileSystem": {"requestFileSystem"}“ ist erforderlich. Nur für Kiosk-Apps verfügbar, die in der Kiosksitzung ausgeführt werden. Bei einem Fehler ist volumes nicht definiert und chrome.runtime.lastError wird festgelegt.

Parameters

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (volumes?: Volume[])=>void

Rückgaben

  • Promise<Volumen[]|nicht definiert>

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.

getWritableEntry()

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

Ruft einen beschreibbaren Eintrag von einem anderen Eintrag ab. Dieser Aufruf schlägt mit einem Laufzeitfehler fehl, wenn die Anwendung keine Schreibberechtigung unter „fileSystem“ hat. Ist der Eintrag ein DirectoryEntry, schlägt dieser Aufruf fehl, wenn die Anwendung nicht über die Berechtigung „directory“ unter „fileSystem“ verfügt.

Parameters

  • Eintrag

    Eintrag

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (entry: Entry)=>void

    • Eintrag

      Eintrag

isRestorable()

Versprechen 
chrome.fileSystem.isRestorable(
  id: string,
  callback?: function,
)

Gibt zurück, ob die App die Berechtigung hat, den Eintrag mit der angegebenen ID wiederherzustellen

Parameters

  • id

    String

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (isRestorable: boolean)=>void

    • isRestorable

      boolean

Rückgaben

  • Promise<boolean>

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.

isWritableEntry()

Versprechen 
chrome.fileSystem.isWritableEntry(
  entry: Entry,
  callback?: function,
)

Ruft ab, ob dieser Eintrag beschreibbar ist oder nicht.

Parameters

  • Eintrag

    Eintrag

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (isWritable: boolean)=>void

    • isWritable

      boolean

Rückgaben

  • Promise<boolean>

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.

requestFileSystem()

Versprechen Chrome 44 oder höher 
chrome.fileSystem.requestFileSystem(
  options: RequestFileSystemOptions,
  callback?: function,
)

Fordert Zugriff auf ein Dateisystem für ein Volume an, das durch options.volumeId dargestellt wird. Wenn options.writable auf „true“ gesetzt ist, ist das Dateisystem beschreibbar. Andernfalls ist es schreibgeschützt. Für die Option writable ist die Berechtigung "fileSystem": {"write"} im Manifest erforderlich. Nur für Kiosk-Apps verfügbar, die in einer Kiosksitzung ausgeführt werden. Beim manuellen Starten des Kioskmodus wird über dem aktiven App-Fenster ein Bestätigungsdialogfeld angezeigt. Bei einem Fehler ist fileSystem nicht definiert und chrome.runtime.lastError wird festgelegt.

Parameters

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (fileSystem?: FileSystem)=>void

    • fileSystem

      FileSystem optional

Rückgaben

  • Promise<FileSystem|undefined>

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.

restoreEntry()

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

Gibt den Dateieintrag mit der angegebenen ID zurück, wenn er wiederhergestellt werden kann. Andernfalls schlägt der Aufruf mit einem Laufzeitfehler fehl.

Parameters

  • id

    String

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (entry: Entry)=>void

    • Eintrag

      Eintrag

retainEntry()

chrome.fileSystem.retainEntry(
  entry: Entry,
)

Gibt eine ID zurück, die anrecoveryEntry übergeben werden kann, um wieder Zugriff auf einen bestimmten Dateieintrag zu erhalten. Es werden nur die 500 zuletzt verwendeten Einträge beibehalten. Dabei zählen „keepEntry“- und „recoveryEntry“-Aufrufe als Nutzung. Wenn die App unter „fileSystem“ die Berechtigung „retainEntries“ hat, werden Einträge auf unbestimmte Zeit aufbewahrt. Andernfalls werden Einträge nur während der Ausführung der Anwendung und nach Neustarts gespeichert.

Parameters

  • Eintrag

    Eintrag

Rückgaben

  • String

Veranstaltungen

onVolumeListChanged

Chrome 44 und höher 
chrome.fileSystem.onVolumeListChanged.addListener(
  callback: function,
)

Wird aufgerufen, wenn eine Liste der verfügbaren Volumes geändert wird.

Parameters