Beschreibung
Mit der chrome.fileSystemProvider
API können Sie Dateisysteme erstellen, auf die über den Dateimanager unter ChromeOS zugegriffen werden kann.
Berechtigungen
fileSystemProvider
Verfügbarkeit
Manifest
Sie müssen die Berechtigung „fileSystemProvider“ und den Abschnitt im Erweiterungsmanifest deklarieren, um die File System Provider API verwenden zu können. 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 wie folgt deklariert werden:
configurable
(boolesch) – optional- Gibt an, ob die Konfiguration über onConfigureRequested unterstützt wird. Der Standardwert ist „false“.
multiple_mounts
(boolesch) – optional- Gibt an, ob mehrere (mehrere) bereitgestellte Dateisysteme unterstützt werden. Der Standardwert ist „false“.
watchable
(boolesch) – optional- Ob das Festlegen von Watchern und das Benachrichtigen über Änderungen unterstützt wird. Der Standardwert ist „false“.
source
(Enum von "file", "device" oder "network"): erforderlich- Datenquelle für bereitgestellte Dateisysteme.
Die Files App verwendet die obigen Informationen, um die zugehörigen UI-Elemente richtig zu rendern. Wenn configurable
beispielsweise auf „true“ gesetzt ist, wird ein Menüpunkt zum Konfigurieren von Volumes gerendert. Wenn multiple_mounts
auf true
gesetzt ist, erlaubt die Files App das Hinzufügen von mehr als einem Bereitstellungspunkt über die UI. Ist für watchable
der Wert false
festgelegt, wird eine Aktualisierungsschaltfläche gerendert. Beachten Sie, dass Sie wenn möglich Support für Watchers hinzufügen sollten, damit Änderungen im Dateisystem sofort und automatisch übernommen werden können.
Überblick
Mit der File System Provider API können Erweiterungen virtuelle Dateisysteme unterstützen, die im Dateimanager unter ChromeOS verfügbar sind. Anwendungsfälle sind beispielsweise das Dekomprimieren von Archiven und der Zugriff auf Dateien in einem anderen Cloud-Dienst als Drive.
Bereitstellen von Dateisystemen
Durch Erweiterungen können entweder Dateisysteminhalte aus einer externen Quelle (z. B. einem Remoteserver oder einem USB-Gerät) bereitgestellt werden oder eine lokale Datei (z. B. ein Archiv) als Eingabe verwendet werden.
Zum Schreiben von Dateisystemen, die Datei-Handler (Quelle ist "file"
) sind, muss der Anbieter eine gepackte Anwendung sein, da das onLaunched
-Ereignis für Erweiterungen nicht verfügbar ist.
Wenn die Quelle ein Netzwerk oder ein Gerät ist, sollte das Dateisystem bereitgestellt werden, wenn das Ereignis onMountRequested aufgerufen wird.
Quelle der Dateisystemdaten | Einstiegspunkt |
---|---|
"file" |
Nur für gepackte 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 bei Dateisystemen, die Inhalte über ein Netzwerk bereitstellen, um die richtigen Anmeldedaten festzulegen. Die Verarbeitung dieses Ereignisses ist optional.
Lebenszyklus
Sobald die bereitgestellten Dateisysteme bereitgestellt wurden, werden sie von Chrome gespeichert und nach einem Neustart oder Neustart automatisch wieder bereitgestellt. Sobald ein Dateisystem durch eine Erweiterung bereitgestellt wird, bleibt es so lange aktiv, bis entweder die Erweiterung entladen wird oder die Erweiterung die Methode Unmount aufruft.
Typen
AbortRequestedOptions
Attribute
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
operationRequestId
Zahl
Die ID der Anfrage, die abgebrochen werden soll.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
Action
Attribute
-
id
String
Die ID der Aktion. Beliebiger String oder
CommonActionId
für gängige Aktionen. -
Titel
String optional
Der Titel der Aktion. Es kann für gängige Aktionen ignoriert werden.
AddWatcherRequestedOptions
Attribute
-
entryPath
String
Der Pfad des zu beobachtenden Eintrags.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
recursive
boolean
Gibt an, ob die Beobachtung alle untergeordneten Einträge rekursiv einschließen soll. Dies kann nur für Verzeichnisse gelten.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
Change
Attribute
-
changeType
Der Typ der Änderung, die dem Eintrag vorgenommen wurde.
-
cloudFileInfo
CloudFileInfo optional
Chrome 125 oder höherInformationen zur Datei, wenn sie von einem Cloud-Dateisystem gestützt werden.
-
entryPath
String
Der Pfad des geänderten Eintrags.
ChangeType
Typ einer im beobachteten Verzeichnis erkannten Änderung.
Enum
CloseFileRequestedOptions
Attribute
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
openRequestId
Zahl
Eine Anfrage-ID, die zum Öffnen der Datei verwendet wird.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
CloudFileInfo
Attribute
-
versionTag
String optional
Ein Tag, das die Version der Datei darstellt.
CloudIdentifier
Attribute
-
id
String
Die Anbieter-ID für die angegebene Datei/das angegebene Verzeichnis.
-
providerName
String
Kennzeichnung des Cloud Storage-Anbieters (z.B. „drive.google.com“).
CommonActionId
Liste häufiger Aktionen. "SHARE"
dient zum Freigeben von Dateien für andere. "SAVE_FOR_OFFLINE"
zum Anpinnen (für Offlinezugriff gespeichert). "OFFLINE_NOT_NECESSARY"
, um Sie darüber zu informieren, dass die Datei nicht mehr für den Offlinezugriff gespeichert werden muss. Wird von onGetActionsRequested
und onExecuteActionRequested
verwendet.
Enum
"OFFLINE_NOT_NECESSARY"
ConfigureRequestedOptions
Attribute
-
fileSystemId
String
Die ID des zu konfigurierenden Dateisystems.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
CopyEntryRequestedOptions
Attribute
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
-
sourcePath
String
Der Quellpfad des Eintrags, der kopiert werden soll.
-
targetPath
String
Der Zielpfad für den Kopiervorgang.
CreateDirectoryRequestedOptions
Attribute
-
directoryPath
String
Der Pfad des Verzeichnisses, das erstellt werden soll.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
recursive
boolean
Gibt an, ob der Vorgang rekursiv ist (nur für Verzeichnisse).
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
CreateFileRequestedOptions
Attribute
-
filePath
String
Der Pfad der zu erstellenden Datei.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
DeleteEntryRequestedOptions
Attribute
-
entryPath
String
Der Pfad des zu löschenden Eintrags.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
recursive
boolean
Gibt an, ob der Vorgang rekursiv ist (nur für Verzeichnisse).
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
EntryMetadata
Attribute
-
cloudFileInfo
CloudFileInfo optional
Chrome 125 oder höherInformationen, die eine bestimmte Datei im zugrunde liegenden Cloud-Dateisystem identifizieren. Muss angegeben werden, falls in
options
angefordert und die Datei wird in Cloud-Speicher gesichert. -
cloudIdentifier
CloudIdentifier optional
Chrome 117 oder höherCloud Storage-Darstellung dieses Eintrags. Muss angegeben werden, falls in
options
angefordert und die Datei wird in Cloud-Speicher gesichert. Bei lokalen Dateien, die nicht im Cloud-Speicher gesichert werden, sollte sie bei Anfrage nicht definiert sein. -
isDirectory
Boolescher Wert 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. Ist immer optional, sollte aber in
options
angegeben werden. -
modificationTime
Datum optional
Der Zeitpunkt der letzten Änderung dieses Eintrags. Muss angegeben werden, wenn in
options
angefordert. -
name
String optional
Name dieses Eintrags (kein vollständiger Pfadname). Darf nicht „/“ enthalten. Das Feld für den Root-Nutzer muss leer sein. Muss angegeben werden, wenn in
options
angefordert. -
Größe
Nummer optional
Dateigröße in Byte. Muss angegeben werden, wenn in
options
angefordert. -
thumbnail
String optional
Miniaturansicht als Daten-URI im PNG-, JPEG- oder WEbP-Format mit einer Größe von maximal 32 KB. Optional, kann aber nur angegeben werden, wenn dies explizit vom
onGetMetadataRequested
-Ereignis angefordert wird.
ExecuteActionRequestedOptions
Attribute
-
actionId
String
Die ID der auszuführenden Aktion.
-
entryPaths
String[]
Chrome 47 und höherDie Pfade der Einträge, die für die Aktion verwendet werden sollen.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
FileSystemInfo
Attribute
-
displayName
String
Ein für Menschen lesbarer Name für das Dateisystem.
-
fileSystemId
String
Die ID des Dateisystems.
-
openedFiles
Liste der aktuell geöffneten Dateien.
-
openedFilesLimit
Zahl
Die maximale Anzahl von Dateien, die gleichzeitig geöffnet werden können. Wenn 0, dann nicht begrenzt.
-
supportsNotifyTag
Boolescher Wert optional
Chrome 45 und höherGibt an, ob das Dateisystem das Feld
tag
zur Beobachtung von Verzeichnissen unterstützt. -
Watcher
Watcher[]
Chrome 45 und höherListe der Watcher.
-
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
Attribute
-
entryPaths
String[]
Chrome 47 und höherListe der Pfade der Einträge für die Liste der Aktionen.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
GetMetadataRequestedOptions
Attribute
-
cloudFileInfo
boolean
Chrome 125 oder höherLegen Sie
true
fest, wenn der WertcloudFileInfo
angefordert wird. -
cloudIdentifier
boolean
Chrome 117 oder höherLegen Sie
true
fest, wenn der WertcloudIdentifier
angefordert wird. -
entryPath
String
Der Pfad des Eintrags, zu dem Metadaten abgerufen werden sollen.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
isDirectory
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der Wertis_directory
angefordert wird. -
mimeType
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der WertmimeType
angefordert wird. -
modificationTime
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der WertmodificationTime
angefordert wird. -
name
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der Wertname
angefordert wird. -
requestId
Zahl
Die eindeutige ID dieser Anfrage.
-
Größe
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der Wertsize
angefordert wird. -
thumbnail
boolean
Legen Sie
true
fest, wenn der Wertthumbnail
angefordert wird.
MountOptions
Attribute
-
displayName
String
Ein für Menschen lesbarer Name für das Dateisystem.
-
fileSystemId
String
Die Stringkennung des Dateisystems. Muss für jede Erweiterung eindeutig sein.
-
openedFilesLimit
Nummer optional
Die maximale Anzahl von Dateien, die gleichzeitig geöffnet werden können. Falls nicht angegeben, oder 0, dann nicht begrenzt.
-
nichtflüchtige
Boolescher Wert optional
Chrome 64 und höherGibt an, ob das Framework das Dateisystem bei der nächsten Anmeldesitzung fortsetzen soll. Standardmäßig "true".
-
supportsNotifyTag
Boolescher Wert optional
Chrome 45 und höherGibt an, ob das Dateisystem das Feld
tag
für beobachtete Verzeichnisse unterstützt. -
Bearbeitbar
Boolescher Wert 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 ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
requestId
Zahl
Die eindeutige ID 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
Der Typ der Änderung, die an dem beobachteten Eintrag vorgenommen wurde. Wenn es DELETED ist, wird der beobachtete Eintrag automatisch aus der Liste der beobachteten Einträge entfernt.
-
Änderungen
Änderung[] optional
Liste der Änderungen an Einträgen im beobachteten Verzeichnis (einschließlich des Eintrags selbst)
-
fileSystemId
String
Die ID des Dateisystems, das mit dieser Änderung in Zusammenhang steht.
-
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. Beachten Sie, dass dieses Flag erforderlich ist, um Benachrichtigungen über Änderungen zu senden, die sich auch beim Herunterfahren des Systems geändert haben.
OpenedFile
Attribute
-
filePath
String
Der Pfad der geöffneten Datei.
-
Modus
Gibt an, ob die Datei zum Lesen oder Schreiben geöffnet wurde.
-
openRequestId
Zahl
Eine Anfrage-ID, die von aufeinanderfolgenden Lese-/Schreib- und Schließanfragen verwendet werden soll.
OpenFileMode
Modus zum Öffnen einer Datei. Wird von onOpenFileRequested
verwendet.
Enum
OpenFileRequestedOptions
Attribute
-
filePath
String
Der Pfad der Datei, die geöffnet werden soll.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
Modus
Gibt an, ob die Datei zum Lesen oder Schreiben verwendet wird.
-
requestId
Zahl
Eine Anfrage-ID, die von aufeinanderfolgenden Lese-/Schreib- und Schließanfragen verwendet wird.
ProviderError
Fehlercodes, die durch die Bereitstellung von Erweiterungen als Antwort auf Anfragen sowie im Fall von Fehlern beim Aufrufen von Methoden der API verwendet werden Für den Erfolg muss "OK"
verwendet werden.
Enum
"OK"
"ACCESS_DENIED"
"NO_SPACE"
"NOT_A_DIRECTORY"
"INVALID_OPERATION"
"NOT_A_FILE"
ReadDirectoryRequestedOptions
Attribute
-
directoryPath
String
Der Pfad des Verzeichnisses, dessen Inhalte angefordert werden.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
isDirectory
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der Wertis_directory
angefordert wird. -
mimeType
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der WertmimeType
angefordert wird. -
modificationTime
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der WertmodificationTime
angefordert wird. -
name
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der Wertname
angefordert wird. -
requestId
Zahl
Die eindeutige ID dieser Anfrage.
-
Größe
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der Wertsize
angefordert wird. -
thumbnail
boolean
Chrome 49 und höherLegen Sie
true
fest, wenn der Wertthumbnail
angefordert wird.
ReadFileRequestedOptions
Attribute
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
Länge
Zahl
Anzahl der Bytes, die zurückgegeben werden sollen.
-
kompensiert
Zahl
Position in der Datei (in Byte), ab der mit dem Lesen begonnen werden soll.
-
openRequestId
Zahl
Eine Anfrage-ID, die zum Öffnen der Datei verwendet wird.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
RemoveWatcherRequestedOptions
Attribute
-
entryPath
String
Der Pfad des beobachteten Eintrags.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
recursive
boolean
Modus des Watchers.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
TruncateRequestedOptions
Attribute
-
filePath
String
Der Pfad der Datei, die abgeschnitten werden soll.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
Länge
Zahl
Anzahl der Byte, die nach Abschluss des Vorgangs aufbewahrt werden sollen.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
UnmountOptions
Attribute
-
fileSystemId
String
Die ID des Dateisystems, das getrennt werden soll.
UnmountRequestedOptions
Attribute
-
fileSystemId
String
Die ID des Dateisystems, das getrennt werden soll.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
Watcher
Attribute
-
entryPath
String
Der Pfad des beobachteten Eintrags.
-
lastTag
String optional
Von der letzten Benachrichtigung an den Watcher verwendetes Tag.
-
recursive
boolean
Gibt an, ob die Beobachtung alle untergeordneten Einträge rekursiv einschließen soll. Dies kann nur für Verzeichnisse gelten.
WriteFileRequestedOptions
Attribute
-
daten
ArrayBuffer
Puffer von Byte, die in die Datei geschrieben werden sollen.
-
fileSystemId
String
Die ID des Dateisystems, das sich auf diesen Vorgang bezieht.
-
kompensiert
Zahl
Position in der Datei (in Byte), ab der die Byte geschrieben werden sollen.
-
openRequestId
Zahl
Eine Anfrage-ID, die zum Öffnen der Datei verwendet wird.
-
requestId
Zahl
Die eindeutige ID dieser Anfrage.
Methoden
get()
chrome.fileSystemProvider.get(
fileSystemId: string,
callback?: function,
)
Gibt Informationen zu einem Dateisystem mit dem übergebenen fileSystemId
zurück.
Parameter
-
fileSystemId
String
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:(fileSystem: FileSystemInfo) => void
-
fileSystem
-
Returns
-
Promise<FileSystemInfo>
Chrome 96 oder höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
getAll()
chrome.fileSystemProvider.getAll(
callback?: function,
)
Gibt alle Dateisysteme zurück, die von der Erweiterung bereitgestellt wurden.
Parameter
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:(fileSystems: FileSystemInfo[]) => void
-
fileSystems
-
Returns
-
Promise<FileSystemInfo[]>
Chrome 96 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
mount()
chrome.fileSystemProvider.mount(
options: MountOptions,
callback?: function,
)
Stellt ein Dateisystem mit den angegebenen fileSystemId
und displayName
bereit. displayName
wird im linken Bereich der App „Dateien“ angezeigt. „displayName
“ kann beliebige Zeichen wie „/“ enthalten, darf aber kein leerer String sein. displayName
muss aussagekräftig, aber nicht eindeutig sein. fileSystemId
darf kein leerer String sein.
Je nach Typ des bereitgestellten Dateisystems muss die Option source
entsprechend festgelegt sein.
Bei einem Fehler wird für runtime.lastError
ein entsprechender Fehlercode festgelegt.
Parameter
-
Optionen
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Returns
-
Promise<void>
Chrome 96 oder höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
notify()
chrome.fileSystemProvider.notify(
options: NotifyOptions,
callback?: function,
)
Benachrichtigt dich über Änderungen im beobachteten Verzeichnis um observedPath
im recursive
-Modus. Wenn das Dateisystem mit supportsNotifyTag
bereitgestellt wird, muss tag
angegeben werden. Außerdem werden alle Änderungen seit der letzten Benachrichtigung immer gemeldet, auch wenn das System heruntergefahren wurde. Das letzte Tag kann mit getAll
abgerufen werden.
Damit die Manifestoption file_system_provider.notify
verwendet werden kann, muss sie auf „true“ gesetzt sein.
Der Wert von tag
kann ein beliebiger String sein, der pro Aufruf eindeutig ist. So kann die letzte 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 mit „123“ gekennzeichneten Änderung vorgenommen wurden. Er darf kein leerer String sein.
Nicht alle Anbieter können ein Tag bereitstellen. Wenn das Dateisystem jedoch ein Änderungsprotokoll enthält, kann das Tag z. B. eine Änderungsnummer oder eine Versionsnummer sein.
Wenn ein übergeordnetes Verzeichnis entfernt wird, werden auch alle untergeordneten Einträge entfernt. Werden sie beobachtet, muss die API darüber informiert werden. Wenn ein Verzeichnis umbenannt wird, werden auch alle untergeordneten Einträge entfernt, da unter ihren ursprünglichen Pfaden kein Eintrag mehr vorhanden ist.
Bei einem Fehler wird für runtime.lastError
ein entsprechender Fehlercode festgelegt.
Parameter
-
Optionen
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Returns
-
Promise<void>
Chrome 96 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
unmount()
chrome.fileSystemProvider.unmount(
options: UnmountOptions,
callback?: function,
)
Hebt die Bereitstellung eines Dateisystems mit der angegebenen fileSystemId
auf. Sie muss aufgerufen werden, nachdem onUnmountRequested
aufgerufen wurde. Die Erweiterung kann auch entscheiden, dass die Bereitstellung aufgehoben wird, wenn sie nicht angefordert wird (z. B. bei unterbrochener Verbindung oder Dateifehler).
Bei einem Fehler wird für runtime.lastError
ein entsprechender Fehlercode festgelegt.
Parameter
-
Optionen
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Returns
-
Promise<void>
Chrome 96 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
Veranstaltungen
onAbortRequested
chrome.fileSystemProvider.onAbortRequested.addListener(
callback: function,
)
Wird ausgegeben, wenn der Abbruch eines Vorgangs mit operationRequestId
angefordert wird. Der mit operationRequestId
ausgeführte Vorgang muss sofort beendet und successCallback
dieser Abbruchanfrage ausgeführt werden. Wenn der Abbruch 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
wird die Anfrage möglicherweise abgebrochen.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: AbortRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onAddWatcherRequested
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn ein neuer Verzeichnis-Watcher angefordert wird. Wenn ein Fehler auftritt, muss errorCallback
aufgerufen werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: AddWatcherRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onCloseFileRequested
chrome.fileSystemProvider.onCloseFileRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn das Schließen einer Datei angefordert wird, die zuvor mit openRequestId
geöffnet wurde.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: CloseFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onConfigureRequested
chrome.fileSystemProvider.onConfigureRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn ein Konfigurationsdialogfeld für fileSystemId
angefordert wird. Wenn sie akzeptiert wird, muss die Option file_system_provider.configurable
auf „true“ gesetzt sein.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: ConfigureRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onCopyEntryRequested
chrome.fileSystemProvider.onCopyEntryRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn ein Eintrag (rekursiv, wenn ein Verzeichnis kopiert wird) 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
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onCreateDirectoryRequested
chrome.fileSystemProvider.onCreateDirectoryRequested.addListener(
callback: function,
)
Wird ausgegeben, wenn das Erstellen eines Verzeichnisses angefordert wird. Wenn das Zielverzeichnis bereits vorhanden ist, muss der Vorgang mit dem Fehler EXISTS fehlschlagen. Wenn recursive
„true“ ist, müssen alle fehlenden Verzeichnisse im Verzeichnispfad erstellt werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: CreateDirectoryRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
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
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onDeleteEntryRequested
chrome.fileSystemProvider.onDeleteEntryRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn das Löschen eines Eintrags angefordert wird. Wenn recursive
wahr ist und der Eintrag ein Verzeichnis ist, müssen auch alle darin enthaltenen Einträge rekursiv gelöscht werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: DeleteEntryRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onExecuteActionRequested
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn eine Aktion für eine Reihe von Dateien oder Verzeichnissen angefordert wird. Nachdem die Aktion abgeschlossen ist, muss successCallback
aufgerufen werden. Bei einem Fehler muss errorCallback
aufgerufen werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: ExecuteActionRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onGetActionsRequested
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 auf jeden Eintrag zutreffen. Wenn keine solchen Aktionen vorhanden sind, sollte ein leeres Array zurückgegeben werden. Die Aktionen müssen mit dem successCallback
-Aufruf zurückgegeben werden. Im Fall eines Fehlers muss errorCallback
aufgerufen werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: GetActionsRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:(actions: Action[]) => void
-
Aktionen
Aktion[]
-
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
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 Fall eines Fehlers muss errorCallback
aufgerufen werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: GetMetadataRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:(metadata: EntryMetadata) => void
-
Metadaten
-
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onMountRequested
chrome.fileSystemProvider.onMountRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn ein Dialogfeld zum Bereitstellen eines neuen Dateisystems angefordert wird. Wenn die Erweiterung/App ein Datei-Handler ist, sollte dieses Ereignis nicht verarbeitet werden. Stattdessen sollte app.runtime.onLaunched
verarbeitet werden, um neue Dateisysteme beim Öffnen einer Datei bereitzustellen. Bei mehreren Bereitstellungen muss die Manifestoption file_system_provider.multiple_mounts
auf „true“ gesetzt sein.
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
-
error
-
-
onMoveEntryRequested
chrome.fileSystemProvider.onMoveEntryRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn ein Eintrag (rekursiv, wenn ein Verzeichnis angefordert wird) verschoben 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
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
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. Mit MountOptions
kann die maximale Anzahl von Dateien angegeben werden, die gleichzeitig geöffnet werden sollen.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: OpenFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:(metadata?: EntryMetadata) => void
-
Metadaten
EntryMetadata optional
-
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onReadDirectoryRequested
chrome.fileSystemProvider.onReadDirectoryRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn Inhalte eines Verzeichnisses unter directoryPath
angefordert werden. Die Ergebnisse müssen in Blöcken zurückgegeben werden, indem successCallback
mehrmals aufgerufen wird. Im Fall eines Fehlers muss errorCallback
aufgerufen werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: ReadDirectoryRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:(entries: EntryMetadata[], hasMore: boolean) => void
-
entries
-
hasMore
boolean
-
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onReadFileRequested
chrome.fileSystemProvider.onReadFileRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn das Lesen von Inhalten einer Datei, die zuvor mit openRequestId
geöffnet wurde, angefordert wird. Die Ergebnisse müssen in Blöcken zurückgegeben werden, indem successCallback
mehrmals aufgerufen wird. Im Fall eines Fehlers muss errorCallback
aufgerufen werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: ReadFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
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
-
error
-
-
onRemoveWatcherRequested
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn der Watcher entfernt werden soll. Wenn ein Fehler auftritt, muss errorCallback
aufgerufen werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: RemoveWatcherRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onTruncateRequested
chrome.fileSystemProvider.onTruncateRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn eine Datei auf eine gewünschte Länge gekürzt wird. Wenn ein Fehler auftritt, muss errorCallback
aufgerufen werden.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: TruncateRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onUnmountRequested
chrome.fileSystemProvider.onUnmountRequested.addListener(
callback: function,
)
Wird ausgegeben, wenn das Trennen der Bereitstellung 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 Trennen 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
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-
onWriteFileRequested
chrome.fileSystemProvider.onWriteFileRequested.addListener(
callback: function,
)
Wird ausgelöst, wenn das Schreiben von Inhalten in eine Datei angefordert wird, die zuvor mit openRequestId
geöffnet wurde.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(options: WriteFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
Optionen
-
successCallback
Funktion
Der Parameter
successCallback
sieht so aus:() => void
-
errorCallback
Funktion
Der Parameter
errorCallback
sieht so aus:(error: ProviderError) => void
-
error
-
-