chrome.fileSystem

Beschreibung

Die chrome.fileSystem API zum Erstellen, Lesen, Navigieren und Schreiben im lokalen Dateisystem des Nutzers verwenden Mit dieser API können Chrome-Apps an einem vom Nutzer ausgewählten Standort lesen und schreiben. Eine Texteditor-App kann die API beispielsweise verwenden, um lokale Dokumente zu lesen und zu schreiben. Alle Fehler werden über „chrome.runtime.lastError“ benachrichtigt.

Berechtigungen

fileSystem

Verfügbarkeit

<ph type="x-smartling-placeholder"></ph> 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. Enthält normalerweise eine erweiterte Liste gültiger Erweiterungen (z.B. kann „text/html“ zu „*.html, *.htm“) erweitert werden.

  • Erweiterungen

    string[] optional

    Zu akzeptierende Erweiterungen, z.B. „jpg“, „gif“, „crx“.

  • mimeTypes

    string[] optional

    Zu akzeptierende MIME-Typen, z.B. „Bild/JPEG“ oder „Audio/*“. MIME-Typen oder Erweiterungen müssen mindestens ein gültiges Element enthalten.

ChooseEntryOptions

Attribute

  • akzeptiert

    AcceptOption[] optional

    Die optionale Liste der 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 Argument vorgesehenen Optionen alle Dateitypen akzeptiert werden. Die Standardeinstellung ist "true". Wenn das Feld „Akzeptiert“ 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 einzigen 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 Aufforderung, die angezeigt werden soll. Der Standardwert ist „openFile“.

ChooseEntryType

Enum

&quot;openFile&quot;
Weist den Nutzer auf, eine vorhandene Datei zu öffnen, und gibt im Erfolgsfall einen FileEntry zurück. Ab Chrome 31 ist FileEntry beschreibbar, wenn die Anwendung über „write“ verfügt. Berechtigung unter „fileSystem“; Andernfalls ist FileEntry schreibgeschützt.

&quot;openWritableFile&quot;
Weist den Nutzer zum Öffnen einer vorhandenen Datei auf und gibt im Erfolgsfall einen beschreibbaren FileEntry zurück. Aufrufe dieses Typs schlagen mit einem Laufzeitfehler fehl, wenn die Anwendung nicht über die Schreibberechtigung verfügt. unter „fileSystem“.

"saveFile"
Fordert den Nutzer auf, eine vorhandene oder eine neue Datei zu öffnen, und gibt im Erfolgsfall einen beschreibbaren FileEntry zurück. Aufrufe dieses Typs schlagen mit einem Laufzeitfehler fehl, wenn die Anwendung nicht über die Schreibberechtigung verfügt. unter „fileSystem“.

&quot;openDirectory&quot;
Fordert den Nutzer auf, ein Verzeichnis zu öffnen, und gibt im Erfolgsfall einen DirectoryEntry zurück. Aufrufe dieses Typs schlagen mit einem Laufzeitfehler fehl, wenn die Anwendung nicht über das Verzeichnis unter „fileSystem“. Wenn die Anwendung über die Schreibberechtigung verfügt unter "fileSystem" hat, ist der zurückgegebene DirectoryEntry beschreibbar. Andernfalls ist sie schreibgeschützt. Neu in Chrome 31.

RequestFileSystemOptions

Chrome (ab Version 44)

Attribute

  • volumeId

    String

    Die ID des angeforderten Volumes.

  • Bearbeitbar

    Boolescher Wert optional

    Legt fest, ob das angeforderte Dateisystem beschreibbar sein soll. Die Standardeinstellung ist schreibgeschützt.

Volume

Chrome (ab Version 44)

Attribute

  • volumeId

    String

  • Bearbeitbar

    boolean

VolumeListChangedEvent

Chrome (ab Version 44)

Attribute

Methoden

chooseEntry()

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

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

Parameter

  • Optionen

    ChooseEntryOptions optional

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

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

    • Eintrag

      Eintrag optional

    • fileEntries

      FileEntry[] optional

getDisplayPath()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.fileSystem.getDisplayPath(
  entry: Entry,
  callback?: function,
)

Ruft den Anzeigepfad eines Eintragsobjekts ab. Der angezeigte Pfad basiert auf dem vollständigen Pfad der Datei oder des Verzeichnisses im lokalen Dateisystem, kann aber für Anzeigezwecke leichter lesbar sein.

Parameter

  • Eintrag

    Eintrag

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (displayPath: string) => void

    • displayPath

      String

Gibt Folgendes zurück:

  • Promise&lt;string&gt;

    Chrome 117 oder höher

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

getVolumeList()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome (ab Version 44) 
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.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (volumes?: Volume[]) => void

Gibt Folgendes zurück:

  • Promise&lt;Volume[] | nicht definiert>

    Chrome 117 oder höher

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

getWritableEntry()

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

Einen beschreibbaren Eintrag aus einem anderen Eintrag abrufen. Dieser Aufruf schlägt mit einem Laufzeitfehler fehl, wenn die Anwendung nicht über die unter „fileSystem“. Wenn der Eintrag ein DirectoryEntry ist, schlägt dieser Aufruf fehl, wenn die Anwendung nicht über das Verzeichnis „directory“ verfügt. unter „fileSystem“.

Parameter

  • Eintrag

    Eintrag

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (entry: Entry) => void

    • Eintrag

      Eintrag

isRestorable()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.fileSystem.isRestorable(
  id: string,
  callback?: function,
)

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

Parameter

  • id

    String

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (isRestorable: boolean) => void

    • isRestorable

      boolean

Gibt Folgendes zurück:

  • Promise&lt;boolean&gt;

    Chrome 117 oder höher

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

isWritableEntry()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.fileSystem.isWritableEntry(
  entry: Entry,
  callback?: function,
)

Ruft ab, ob dieser Eintrag beschreibbar ist oder nicht.

Parameter

  • Eintrag

    Eintrag

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (isWritable: boolean) => void

    • isWritable

      boolean

Gibt Folgendes zurück:

  • Promise&lt;boolean&gt;

    Chrome 117 oder höher

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

requestFileSystem()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome (ab Version 44) 
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. Im manuellen Kioskmodus wird über dem aktiven App-Fenster ein Bestätigungsdialogfeld angezeigt. Bei einem Fehler ist fileSystem nicht definiert und chrome.runtime.lastError wird festgelegt.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (fileSystem?: FileSystem) => void

    • fileSystem

      FileSystem (optional)

Gibt Folgendes zurück:

  • Promise&lt;FileSystem | nicht definiert>

    Chrome 117 oder höher

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

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 dieser Aufruf mit einem Laufzeitfehler fehl.

Parameter

  • id

    String

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (entry: Entry) => void

    • Eintrag

      Eintrag

retainEntry()

chrome.fileSystem.retainEntry(
  entry: Entry,
)

Gibt eine ID zurück, die anrecoveryEntry übergeben werden kann, um den Zugriff auf einen bestimmten Dateieintrag wiederherzustellen. Es werden nur die 500 zuletzt verwendeten Einträge aufbewahrt, wobei die Aufrufe „retainEntry“ und „reaktivierenEntry“ als Nutzung zählen. Ob die App die Einstellung „retainEntries“ unter „fileSystem“ zulassen, werden Einträge auf unbestimmte Zeit aufbewahrt. Andernfalls werden Einträge nur aufbewahrt, während die Anwendung ausgeführt wird und während eines Neustarts.

Parameter

  • Eintrag

    Eintrag

Gibt Folgendes zurück:

  • String

Ereignisse

onVolumeListChanged

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

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

Parameter