chrome.fileSystemProvider

Beschreibung

Mit der chrome.fileSystemProvider API können Sie Dateisysteme erstellen, auf die über den Dateimanager in ChromeOS zugegriffen werden kann.

Berechtigungen

fileSystemProvider

Verfügbarkeit

Nur ChromeOS

Wenn Sie die File System Provider API verwenden möchten, müssen Sie die Berechtigung und den Abschnitt „fileSystemProvider“ im Erweiterungsmanifest deklarieren. Beispiel:

{
  "name": "My extension",
  ...
  "permissions": [
    "fileSystemProvider"
  ],
  ...
  "file_system_provider_capabilities": {
    "configurable": true,
    "watchable": false,
    "multiple_mounts": true,
    "source": "network"
  },
  ...
}

Der Abschnitt „file_system_provider“ muss so deklariert werden:

configurable (boolesch) – optional
Gibt an, ob die Konfiguration über „onConfigureRequested“ unterstützt wird. Standard: false.
multiple_mounts (boolesch) – optional
Gibt an, ob mehrere (mehr als ein) bereitgestellte Dateisysteme unterstützt werden. Standard: false.
watchable (boolesch) – optional
Gibt an, ob das Festlegen von Beobachtern und das Benachrichtigen über Änderungen unterstützt wird. Standard: false.
source (enum von „file“, „device“ oder „network“) – erforderlich
Datenquelle für bereitgestellte Dateisysteme.

Die Dateien App verwendet die oben genannten Informationen, um zugehörige UI-Elemente entsprechend darzustellen. Wenn configurable beispielsweise auf „true“ gesetzt ist, wird ein Menüelement zum Konfigurieren von Lautstärken gerendert. Wenn multiple_mounts auf true gesetzt ist, können in der Dateien App über die Benutzeroberfläche mehrere Bereitstellungspunkte hinzugefügt werden. Wenn watchable gleich false ist, wird eine Schaltfläche zum Aktualisieren gerendert. Wenn möglich, sollten Sie Unterstützung für Watcher hinzufügen, damit Änderungen am Dateisystem sofort und automatisch übernommen werden können.

Übersicht

Mit der File System Provider API können Erweiterungen virtuelle Dateisysteme unterstützen, die in der Dateiverwaltung unter ChromeOS verfügbar sind. Anwendungsfälle sind unter anderem das Dekomprimieren von Archiven und der Zugriff auf Dateien in einem anderen Cloud-Dienst als Drive.

Bereitstellen von Dateisystemen

Erweiterungen können entweder Dateisysteminhalte aus einer externen Quelle (z. B. einem Remoteserver oder einem USB-Gerät) oder eine lokale Datei (z. B. ein Archiv) als Eingabe verwenden.

Um Dateisysteme zu schreiben, die Datei-Handler sind (Quelle ist "file"), muss der Anbieter eine verpackte App sein, da das onLaunched-Ereignis für Erweiterungen nicht verfügbar ist.

Wenn die Quelle das Netzwerk oder ein Gerät ist, sollte das Dateisystem eingebunden werden, wenn das onMountRequested-Ereignis aufgerufen wird.

Quelle der Dateisystemdaten Einstiegspunkt
"file" Nur für verpackte Apps verfügbar.
"device" oder "network" onMountRequested

Dateisysteme konfigurieren

Bereitgestellte Dateisysteme können nach der Bereitstellung über das Ereignis onConfigureRequested konfiguriert werden. Dies ist besonders nützlich für Dateisysteme, die Inhalte über das Netzwerk bereitstellen, um die richtigen Anmeldedaten festzulegen. Die Verarbeitung dieses Ereignisses ist optional.

Lebenszyklus

Bereitgestellte Dateisysteme werden nach der Bereitstellung von Chrome gespeichert und nach einem Neustart automatisch wieder bereitgestellt. Wenn ein Dateisystem von einer bereitstellenden Erweiterung gemountet wird, bleibt es also so lange bestehen, bis die Erweiterung entladen wird oder die Erweiterung die Methode unmount aufruft.

Typen

AbortRequestedOptions

Attribute

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • operationRequestId

    Zahl

    Eine ID der abzubrechenden Anfrage.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

Action

Chrome 45 und höher

Attribute

  • id

    String

    Die Kennung der Aktion. Ein beliebiger String oder CommonActionId für häufige Aktionen.

  • Titel

    String optional

    Der Titel der Aktion. Bei häufigen Aktionen wird sie möglicherweise ignoriert.

AddWatcherRequestedOptions

Attribute

  • entryPath

    String

    Der Pfad des zu beobachtenden Eintrags.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • recursive

    boolean

    Gibt an, ob die Beobachtung rekursiv alle untergeordneten Einträge umfassen soll. Es kann nur für Verzeichnisse auf „true“ festgelegt sein.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

Change

Attribute

  • changeType

    ChangeType

    Die Art der Änderung, die am Eintrag vorgenommen wurde.

  • cloudFileInfo

    CloudFileInfo optional

    Chrome 125 und höher

    Informationen zur Datei, wenn sie von einem Cloud-Dateisystem unterstützt wird.

  • entryPath

    String

    Der Pfad des geänderten Eintrags.

ChangeType

Art der Änderung, die im beobachteten Verzeichnis erkannt wurde.

Enum

"CHANGED"

"DELETED"

CloseFileRequestedOptions

Attribute

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • openRequestId

    Zahl

    Eine Anfrage-ID, die zum Öffnen der Datei verwendet wird.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

CloudFileInfo

Chrome 125 und höher

Attribute

  • versionTag

    String optional

    Ein Tag, das die Version der Datei darstellt.

CloudIdentifier

Chrome 117 und höher

Attribute

  • id

    String

    Die Kennung des Anbieters für die angegebene Datei oder das angegebene Verzeichnis.

  • providerName

    String

    Kennung für den Cloud-Speicheranbieter (z.B. „drive.google.com“).

CommonActionId

Chrome 45 und höher

Liste häufiger Aktionen "SHARE" ist zum Teilen von Dateien mit anderen gedacht. "SAVE_FOR_OFFLINE" zum Pinnen (Speichern für den Offlinezugriff). "OFFLINE_NOT_NECESSARY", um zu benachrichtigen, dass die Datei nicht mehr für den Offlinezugriff gespeichert werden muss. Wird von onGetActionsRequested und onExecuteActionRequested verwendet.

Enum

"SAVE_FOR_OFFLINE"

"OFFLINE_NOT_NECESSARY"

„TEILEN“

ConfigureRequestedOptions

Chrome 44 und höher

Attribute

  • fileSystemId

    String

    Die Kennung des zu konfigurierenden Dateisystems.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

CopyEntryRequestedOptions

Attribute

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

  • sourcePath

    String

    Der Quellpfad des zu kopierenden Eintrags.

  • targetPath

    String

    Der Zielpfad für den Kopiervorgang.

CreateDirectoryRequestedOptions

Attribute

  • directoryPath

    String

    Der Pfad des Verzeichnisses, das erstellt werden soll.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • recursive

    boolean

    Gibt an, ob der Vorgang rekursiv ist (nur für Verzeichnisse).

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

CreateFileRequestedOptions

Attribute

  • filePath

    String

    Der Pfad der Datei, die erstellt werden soll.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

DeleteEntryRequestedOptions

Attribute

  • entryPath

    String

    Der Pfad des zu löschenden Eintrags.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • recursive

    boolean

    Gibt an, ob der Vorgang rekursiv ist (nur für Verzeichnisse).

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

EntryMetadata

Attribute

  • cloudFileInfo

    CloudFileInfo optional

    Chrome 125 und höher

    Informationen, die eine bestimmte Datei im zugrunde liegenden Cloud-Dateisystem identifizieren. Muss angegeben werden, wenn sie in options angefordert wird und die Datei in einem Cloud-Speicher gesichert ist.

  • cloudIdentifier

    CloudIdentifier optional

    Chrome 117 und höher

    Cloud-Speicher-Darstellung dieses Eintrags. Muss angegeben werden, wenn sie in options angefordert wird und die Datei in einem Cloud-Speicher gesichert ist. Bei lokalen Dateien, die nicht durch Cloud-Speicher gesichert sind, sollte der Wert bei einer Anfrage undefiniert sein.

  • isDirectory

    boolean optional

    „True“, wenn es sich um ein Verzeichnis handelt. Muss angegeben werden, wenn in options angefordert.

  • mimeType

    String optional

    MIME-Typ für den Eintrag. Immer optional, sollte aber angegeben werden, wenn in options danach gefragt wird.

  • modificationTime

    Datum optional

    Der Zeitpunkt der letzten Änderung dieses Eintrags. Muss angegeben werden, wenn in options angefordert.

  • name

    String optional

    Name dieses Eintrags (nicht der vollständige Pfadname). Darf kein „/“ enthalten. Für den Stamm muss es leer sein. Muss angegeben werden, wenn in options angefordert.

  • Größe

    number optional

    Dateigröße in Byte. Muss angegeben werden, wenn in options angefordert.

  • Thumbnail

    String optional

    Vorschaubild als Daten-URI im PNG-, JPEG- oder WEBP-Format mit einer Größe von maximal 32 KB. Optional, kann aber nur angegeben werden, wenn das onGetMetadataRequested-Ereignis dies explizit anfordert.

ExecuteActionRequestedOptions

Chrome 45 und höher

Attribute

  • actionId

    String

    Die Kennung der auszuführenden Aktion.

  • entryPaths

    String[]

    Chrome 47 und höher

    Die Menge der Pfade der Einträge, die für die Aktion verwendet werden sollen.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

FileSystemInfo

Attribute

  • displayName

    String

    Ein für Menschen lesbarer Name für das Dateisystem.

  • fileSystemId

    String

    Die Kennung des Dateisystems.

  • openedFiles

    OpenedFile[]

    Liste der aktuell geöffneten Dateien.

  • openedFilesLimit

    Zahl

    Die maximale Anzahl von Dateien, die gleichzeitig geöffnet werden können. Bei 0 gibt es keine Einschränkung.

  • supportsNotifyTag

    boolean optional

    Chrome 45 und höher

    Gibt an, ob das Dateisystem das Feld tag zum Beobachten von Verzeichnissen unterstützt.

  • Beobachter

    Watcher[]

    Chrome 45 und höher

    Liste der Beobachter.

  • Bearbeitbar

    boolean

    Gibt an, ob das Dateisystem Vorgänge unterstützt, die den Inhalt des Dateisystems ändern können, z. B. das Erstellen, Löschen oder Schreiben von Dateien.

GetActionsRequestedOptions

Chrome 45 und höher

Attribute

  • entryPaths

    String[]

    Chrome 47 und höher

    Liste der Pfade von Einträgen für die Liste der Aktionen.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

GetMetadataRequestedOptions

Attribute

  • cloudFileInfo

    boolean

    Chrome 125 und höher

    Legen Sie den Wert auf true fest, wenn der Wert cloudFileInfo angefordert wird.

  • cloudIdentifier

    boolean

    Chrome 117 und höher

    Legen Sie den Wert auf true fest, wenn der Wert cloudIdentifier angefordert wird.

  • entryPath

    String

    Der Pfad des Eintrags, für den Metadaten abgerufen werden sollen.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • isDirectory

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert is_directory angefordert wird.

  • mimeType

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert mimeType angefordert wird.

  • modificationTime

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert modificationTime angefordert wird.

  • name

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert name angefordert wird.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

  • Größe

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert size angefordert wird.

  • Thumbnail

    boolean

    Legen Sie den Wert auf true fest, wenn der Wert thumbnail angefordert wird.

MountOptions

Attribute

  • displayName

    String

    Ein für Menschen lesbarer Name für das Dateisystem.

  • fileSystemId

    String

    Die String-Kennung des Dateisystems. Muss für jede Erweiterung eindeutig sein.

  • openedFilesLimit

    number optional

    Die maximale Anzahl von Dateien, die gleichzeitig geöffnet werden können. Wenn nicht angegeben oder 0, gibt es kein Limit.

  • nichtflüchtige

    boolean optional

    Chrome 64 und höher

    Gibt an, ob das Framework das Dateisystem bei der nächsten Anmeldesitzung fortsetzen soll. Standardmäßig „true“.

  • supportsNotifyTag

    boolean optional

    Chrome 45 und höher

    Gibt an, ob das Dateisystem das Feld tag für beobachtete Verzeichnisse unterstützt.

  • Bearbeitbar

    boolean optional

    Gibt an, ob das Dateisystem Vorgänge unterstützt, die den Inhalt des Dateisystems ändern können, z. B. das Erstellen, Löschen oder Schreiben von Dateien.

MoveEntryRequestedOptions

Attribute

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

  • sourcePath

    String

    Der Quellpfad des Eintrags, der an einen neuen Ort verschoben werden soll.

  • targetPath

    String

    Der Zielpfad für den Kopiervorgang.

NotifyOptions

Attribute

  • changeType

    ChangeType

    Die Art der Änderung, die am beobachteten Eintrag vorgenommen wurde. Wenn er GELÖSCHT wird, wird der beobachtete Eintrag automatisch aus der Liste der beobachteten Einträge entfernt.

  • Änderungen

    Change[] optional

    Liste der Änderungen an Einträgen im beobachteten Verzeichnis (einschließlich des Eintrags selbst)

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit dieser Änderung zusammenhängt.

  • observedPath

    String

    Der Pfad des beobachteten Eintrags.

  • recursive

    boolean

    Modus des beobachteten Eintrags.

  • Tag

    String optional

    Tag für die Benachrichtigung. Erforderlich, wenn das Dateisystem mit der Option supportsNotifyTag bereitgestellt wurde. Diese Markierung ist erforderlich, um Benachrichtigungen über Änderungen zu senden, die auch dann vorgenommen wurden, wenn das System heruntergefahren war.

OpenedFile

Attribute

  • filePath

    String

    Der Pfad der geöffneten Datei.

  • Modus

    OpenFileMode

    Gibt an, ob die Datei zum Lesen oder Schreiben geöffnet wurde.

  • openRequestId

    Zahl

    Eine Anfrage-ID, die für aufeinanderfolgende Lese-/Schreib- und Schließanfragen verwendet werden soll.

OpenFileMode

Art des Öffnens einer Datei. Wird von onOpenFileRequested verwendet.

Enum

„READ“

„WRITE“

OpenFileRequestedOptions

Attribute

  • filePath

    String

    Der Pfad der Datei, die geöffnet werden soll.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • Modus

    OpenFileMode

    Gibt an, ob die Datei zum Lesen oder Schreiben verwendet wird.

  • requestId

    Zahl

    Eine Anfrage-ID, die für nachfolgende Lese-/Schreib- und Schließanfragen verwendet wird.

ProviderError

Fehlercodes, die von Erweiterungen verwendet werden, wenn sie auf Anfragen reagieren, sowie bei Fehlern beim Aufrufen von Methoden der API. Für den Erfolg muss "OK" verwendet werden.

Enum

„OK“

"FAILED"

"IN_USE"

"EXISTS"

"NOT_FOUND"

"ACCESS_DENIED"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NO_SPACE"

"NOT_A_DIRECTORY"

"INVALID_OPERATION"

"SECURITY"

"ABORT"

"NOT_A_FILE"

"NOT_EMPTY"

"INVALID_URL"

„IO“

ReadDirectoryRequestedOptions

Attribute

  • directoryPath

    String

    Der Pfad des Verzeichnisses, dessen Inhalt angefordert wird.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • isDirectory

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert is_directory angefordert wird.

  • mimeType

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert mimeType angefordert wird.

  • modificationTime

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert modificationTime angefordert wird.

  • name

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert name angefordert wird.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

  • Größe

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert size angefordert wird.

  • Thumbnail

    boolean

    Chrome 49 und höher

    Legen Sie den Wert auf true fest, wenn der Wert thumbnail angefordert wird.

ReadFileRequestedOptions

Attribute

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • Länge

    Zahl

    Anzahl der zurückzugebenden Byte.

  • kompensiert

    Zahl

    Position in der Datei (in Byte), ab der gelesen werden soll.

  • openRequestId

    Zahl

    Eine Anfrage-ID, die zum Öffnen der Datei verwendet wird.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

RemoveWatcherRequestedOptions

Attribute

  • entryPath

    String

    Der Pfad des beobachteten Eintrags.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • recursive

    boolean

    Modus des Watcher.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

TruncateRequestedOptions

Attribute

  • filePath

    String

    Der Pfad der Datei, die gekürzt werden soll.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • Länge

    Zahl

    Anzahl der Bytes, die nach Abschluss des Vorgangs beibehalten werden sollen.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

UnmountOptions

Attribute

  • fileSystemId

    String

    Die Kennung des Dateisystems, das getrennt werden soll.

UnmountRequestedOptions

Attribute

  • fileSystemId

    String

    Die Kennung des Dateisystems, das getrennt werden soll.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

Watcher

Attribute

  • entryPath

    String

    Der Pfad des beobachteten Eintrags.

  • lastTag

    String optional

    Tag, das von der letzten Benachrichtigung für den Beobachter verwendet wurde.

  • recursive

    boolean

    Gibt an, ob alle untergeordneten Einträge rekursiv überwacht werden sollen. Es kann nur für Verzeichnisse auf „true“ festgelegt sein.

WriteFileRequestedOptions

Attribute

  • Daten

    ArrayBuffer

    Puffer mit Byte, die in die Datei geschrieben werden sollen.

  • fileSystemId

    String

    Die Kennung des Dateisystems, das mit diesem Vorgang verknüpft ist.

  • kompensiert

    Zahl

    Position in der Datei (in Byte), ab der die Bytes geschrieben werden sollen.

  • openRequestId

    Zahl

    Eine Anfrage-ID, die zum Öffnen der Datei verwendet wird.

  • requestId

    Zahl

    Die eindeutige Kennung dieser Anfrage.

Methoden

get()

chrome.fileSystemProvider.get(
  fileSystemId: string,
): Promise<FileSystemInfo>

Gibt Informationen zu einem Dateisystem mit dem übergebenen fileSystemId zurück.

Parameter

  • fileSystemId

    String

Ausgabe

getAll()

chrome.fileSystemProvider.getAll(): Promise<FileSystemInfo[]>

Gibt alle von der Erweiterung eingebundenen Dateisysteme zurück.

Ausgabe

mount()

chrome.fileSystemProvider.mount(
  options: MountOptions,
): Promise<void>

Stellt ein Dateisystem mit dem angegebenen fileSystemId und displayName bereit. displayName wird in der linken Seitenleiste der Dateien App angezeigt. displayName kann beliebige Zeichen einschließlich „/“ enthalten, darf aber kein leerer String sein. displayName muss aussagekräftig sein, aber nicht eindeutig. fileSystemId darf kein leerer String sein.

Je nach Typ des bereitgestellten Dateisystems muss die Option source entsprechend festgelegt werden.

Im Fehlerfall wird runtime.lastError mit einem entsprechenden Fehlercode festgelegt.

Parameter

Ausgabe

  • Promise<void>

    Chrome 96 und höher

notify()

Chrome 45 und höher 
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
): Promise<void>

Benachrichtigt über Änderungen im überwachten Verzeichnis unter observedPath im Modus recursive. Wenn das Dateisystem mit supportsNotifyTag gemountet wird, muss tag angegeben werden. Alle Änderungen seit der letzten Benachrichtigung werden immer gemeldet, auch wenn das System heruntergefahren wurde. Das letzte Tag kann mit getAll abgerufen werden.

Dazu muss die Manifestoption file_system_provider.notify auf „true“ gesetzt sein.

Der Wert von tag kann ein beliebiger String sein, der pro Anruf eindeutig ist. So kann die zuletzt registrierte Benachrichtigung identifiziert werden. Wenn die bereitstellende Erweiterung beispielsweise nach einem Neustart gestartet wird und das Tag der letzten registrierten Benachrichtigung „123“ ist, sollte notify für alle Änderungen aufgerufen werden, die seit der Änderung mit dem Tag „123“ erfolgt sind. Darf kein leerer String sein.

Nicht alle Anbieter können ein Tag bereitstellen. Wenn das Dateisystem jedoch ein Änderungsprotokoll hat, kann das Tag z. B. eine Änderungs- oder Revisionsnummer sein.

Wenn ein übergeordnetes Verzeichnis entfernt wird, werden auch alle untergeordneten Einträge entfernt. Wenn sie überwacht werden, muss die API darüber benachrichtigt werden. Wenn ein Verzeichnis umbenannt wird, werden alle untergeordneten Einträge entfernt, da es unter den ursprünglichen Pfaden keine Einträge mehr gibt.

Im Fehlerfall wird runtime.lastError mit einem entsprechenden Fehlercode festgelegt.

Parameter

Ausgabe

  • Promise<void>

    Chrome 96 und höher

unmount()

chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
): Promise<void>

Hebt die Bereitstellung eines Dateisystems mit der angegebenen fileSystemId auf. Es muss aufgerufen werden, nachdem onUnmountRequested aufgerufen wurde. Außerdem kann die bereitstellende Erweiterung das Unmounten auch ohne Aufforderung durchführen, z. B. bei Verbindungsverlust oder einem Dateifehler.

Im Fehlerfall wird runtime.lastError mit einem entsprechenden Fehlercode festgelegt.

Parameter

Ausgabe

  • Promise<void>

    Chrome 96 und höher

Ereignisse

onAbortRequested

chrome.fileSystemProvider.onAbortRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn ein Vorgang mit operationRequestId abgebrochen werden soll. Der mit operationRequestId ausgeführte Vorgang muss sofort beendet und successCallback dieser Abbruchanfrage ausgeführt werden. Wenn das Abbrechen fehlschlägt, muss errorCallback aufgerufen werden. Beachten Sie, dass Callbacks des abgebrochenen Vorgangs nicht aufgerufen werden dürfen, da sie ignoriert werden. Trotz des Aufrufs von errorCallback kann die Anfrage zwangsweise abgebrochen werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: AbortRequestedOptions, successCallback: function, errorCallback: function) => void

onAddWatcherRequested

Chrome 45 und höher 
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn ein neuer Verzeichnis-Watcher festgelegt werden soll. Wenn ein Fehler auftritt, muss errorCallback aufgerufen werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: AddWatcherRequestedOptions, successCallback: function, errorCallback: function) => void

onCloseFileRequested

chrome.fileSystemProvider.onCloseFileRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn eine Datei, die zuvor mit openRequestId geöffnet wurde, geschlossen werden soll.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: CloseFileRequestedOptions, successCallback: function, errorCallback: function) => void

onConfigureRequested

Chrome 44 und höher 
chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn ein Konfigurationsdialogfeld für fileSystemId angezeigt werden soll. Wenn sie verarbeitet wird, muss die Manifestoption file_system_provider.configurable auf „true“ gesetzt sein.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: ConfigureRequestedOptions, successCallback: function, errorCallback: function) => void

onCopyEntryRequested

chrome.fileSystemProvider.onCopyEntryRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn das Kopieren eines Eintrags (rekursiv, wenn es sich um ein Verzeichnis handelt) angefordert wird. Wenn ein Fehler auftritt, muss errorCallback aufgerufen werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: CopyEntryRequestedOptions, successCallback: function, errorCallback: function) => void

onCreateDirectoryRequested

chrome.fileSystemProvider.onCreateDirectoryRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn ein Verzeichnis erstellt werden soll. Der Vorgang muss mit dem Fehler EXISTS fehlschlagen, wenn das Zielverzeichnis bereits vorhanden ist. Wenn recursive auf „true“ gesetzt ist, müssen alle fehlenden Verzeichnisse im Verzeichnispfad erstellt werden.

Parameter

onCreateFileRequested

chrome.fileSystemProvider.onCreateFileRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn das Erstellen einer Datei angefordert wird. Wenn die Datei bereits vorhanden ist, muss errorCallback mit dem Fehlercode "EXISTS" aufgerufen werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: CreateFileRequestedOptions, successCallback: function, errorCallback: function) => void

onDeleteEntryRequested

chrome.fileSystemProvider.onDeleteEntryRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn das Löschen eines Eintrags angefordert wird. Wenn recursive „true“ ist und der Eintrag ein Verzeichnis ist, müssen auch alle Einträge darin rekursiv gelöscht werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: DeleteEntryRequestedOptions, successCallback: function, errorCallback: function) => void

onExecuteActionRequested

Chrome 48 und höher 
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn eine Aktion für eine Reihe von Dateien oder Verzeichnissen angefordert wird. Nach Abschluss der Aktion muss successCallback aufgerufen werden. Bei einem Fehler muss errorCallback aufgerufen werden.

Parameter

onGetActionsRequested

Chrome 48 und höher 
chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn eine Liste von Aktionen für eine Reihe von Dateien oder Verzeichnissen unter entryPaths angefordert wird. Alle zurückgegebenen Aktionen müssen für jeden Eintrag gelten. Wenn es keine solchen Aktionen gibt, sollte ein leeres Array zurückgegeben werden. Die Aktionen müssen mit dem successCallback-Aufruf zurückgegeben werden. Im Fehlerfall muss errorCallback aufgerufen werden.

Parameter

onGetMetadataRequested

chrome.fileSystemProvider.onGetMetadataRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn Metadaten einer Datei oder eines Verzeichnisses unter entryPath angefordert werden. Die Metadaten müssen mit dem successCallback-Aufruf zurückgegeben werden. Im Fehlerfall muss errorCallback aufgerufen werden.

Parameter

onMountRequested

Chrome 44 und höher 
chrome.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn ein Dialogfeld zum Mounten eines neuen Dateisystems angezeigt werden soll. Wenn die Erweiterung/App ein Dateihandler ist, sollte dieses Ereignis nicht verarbeitet werden. Stattdessen sollte app.runtime.onLaunched verarbeitet werden, um neue Dateisysteme zu mounten, wenn eine Datei geöffnet wird. Bei mehreren Bereitstellungen muss die Manifestoption file_system_provider.multiple_mounts auf „true“ gesetzt werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (successCallback: function, errorCallback: function) => void

    • successCallback

      Funktion

      Der Parameter successCallback sieht so aus: 

      () => void

    • errorCallback

      Funktion

      Der Parameter errorCallback sieht so aus: 

      (error: ProviderError) => void

onMoveEntryRequested

chrome.fileSystemProvider.onMoveEntryRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn das Verschieben eines Eintrags (rekursiv, wenn es sich um ein Verzeichnis handelt) angefordert wird. Wenn ein Fehler auftritt, muss errorCallback aufgerufen werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: MoveEntryRequestedOptions, successCallback: function, errorCallback: function) => void

onOpenFileRequested

chrome.fileSystemProvider.onOpenFileRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn das Öffnen einer Datei unter filePath angefordert wird. Wenn die Datei nicht vorhanden ist, muss der Vorgang fehlschlagen. Die maximale Anzahl der gleichzeitig geöffneten Dateien kann mit MountOptions angegeben werden.

Parameter

onReadDirectoryRequested

chrome.fileSystemProvider.onReadDirectoryRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn der Inhalt eines Verzeichnisses unter directoryPath angefordert wird. Die Ergebnisse müssen in Chunks zurückgegeben werden, indem die Funktion successCallback mehrmals aufgerufen wird. Im Fehlerfall muss errorCallback aufgerufen werden.

Parameter

onReadFileRequested

chrome.fileSystemProvider.onReadFileRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn der Inhalt einer Datei gelesen werden soll, die zuvor mit openRequestId geöffnet wurde. Die Ergebnisse müssen in Chunks zurückgegeben werden, indem successCallback mehrmals aufgerufen wird. Im Fehlerfall muss errorCallback aufgerufen werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: ReadFileRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      Funktion

      Der Parameter successCallback sieht so aus: 

      (data: ArrayBuffer, hasMore: boolean) => void

      • Daten

        ArrayBuffer

      • hasMore

        boolean

    • errorCallback

      Funktion

      Der Parameter errorCallback sieht so aus: 

      (error: ProviderError) => void

onRemoveWatcherRequested

Chrome 45 und höher 
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn der Watcher entfernt werden soll. Wenn ein Fehler auftritt, muss errorCallback aufgerufen werden.

Parameter

onTruncateRequested

chrome.fileSystemProvider.onTruncateRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn eine Datei auf eine bestimmte Länge gekürzt werden soll. Wenn ein Fehler auftritt, muss errorCallback aufgerufen werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: TruncateRequestedOptions, successCallback: function, errorCallback: function) => void

onUnmountRequested

chrome.fileSystemProvider.onUnmountRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn das Aushängen für das Dateisystem mit der Kennung fileSystemId angefordert wird. In der Antwort muss die API-Methode unmount zusammen mit successCallback aufgerufen werden. Wenn das Unmounten nicht möglich ist (z. B. aufgrund eines ausstehenden Vorgangs), muss errorCallback aufgerufen werden.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: UnmountRequestedOptions, successCallback: function, errorCallback: function) => void

onWriteFileRequested

chrome.fileSystemProvider.onWriteFileRequested.addListener(
  callback: function,
)

Wird ausgelöst, wenn Inhalte in eine Datei geschrieben werden sollen, die zuvor mit openRequestId geöffnet wurde.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (options: WriteFileRequestedOptions, successCallback: function, errorCallback: function) => void