chrome.fileSystemProvider (original) (raw)

Skip to main content

chrome.fileSystemProvider

Beschrijving

Gebruik de chrome.fileSystemProvider API om bestandssystemen te maken die toegankelijk zijn via de bestandsbeheerder in Chrome OS.

Machtigingen

fileSystemProvider

Beschikbaarheid

U moet de machtiging en sectie 'fileSystemProvider' in het extensiemanifest declareren om de File System Provider API te gebruiken. Bijvoorbeeld:

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

De sectie file_system_provider moet als volgt worden gedeclareerd:

configurable (booleaans) - optioneel

Of configuratie via onConfigureRequested wordt ondersteund. Standaard: false.

multiple_mounts (booleaans) - optioneel

Of meerdere (meer dan één) gekoppelde bestandssystemen worden ondersteund. Standaard: false.

watchable (booleaans) - optioneel

Of het instellen van waarnemers en het melden van wijzigingen wordt ondersteund. Standaard: false.

source (enum van "bestand", "apparaat" of "netwerk") - vereist

Gegevensbron voor gekoppelde bestandssystemen.

De Bestanden-app gebruikt bovenstaande informatie om gerelateerde UI-elementen correct weer te geven. Als configurable bijvoorbeeld is ingesteld op true, wordt een menu-item voor het configureren van volumes weergegeven. Als multiple_mounts is ingesteld op true , kan de Bestanden-app meerdere koppelpunten toevoegen vanuit de gebruikersinterface. Als watchable is ingesteld op false , wordt een vernieuwingsknop weergegeven. Voeg indien mogelijk ondersteuning voor watchers toe, zodat wijzigingen in het bestandssysteem direct en automatisch kunnen worden doorgevoerd.

Overzicht

Met de File System Provider API kunnen extensies virtuele bestandssystemen ondersteunen, die beschikbaar zijn in de bestandsbeheerder van ChromeOS. Voorbeelden van toepassingen zijn het decomprimeren van archieven en het openen van bestanden in een andere cloudservice dan Drive.

Bestandssystemen koppelen

U kunt extensies opgeven waarmee u de inhoud van het bestandssysteem van een externe bron (zoals een externe server of een USB-apparaat) kunt aanleveren, of waarmee u een lokaal bestand (zoals een archief) als invoer kunt gebruiken.

Om bestandssystemen te schrijven die bestandsafhandelingsfuncties vervullen (bron is "file" ) moet de provider een verpakte app zijn, aangezien de onLaunched gebeurtenis niet beschikbaar is voor extensies.

Als de bron een netwerk of een apparaat is, moet het bestandssysteem worden gekoppeld wanneer de gebeurtenis onMountRequested wordt aangeroepen.

Bron van de bestandssysteemgegevens Instappunt
"file" Alleen beschikbaar voor pakket-apps.
"device" of "network" opMountRequested

Bestandssystemen configureren

Eenmaal gekoppelde bestandssystemen kunnen worden geconfigureerd via de gebeurtenis onConfigureRequested . Dit is vooral handig voor bestandssystemen die inhoud via het netwerk aanbieden om de juiste referenties in te stellen. Het afhandelen van deze gebeurtenis is optioneel.

Levenscyclus

Eenmaal gekoppelde bestandssystemen worden door Chrome onthouden en automatisch opnieuw gekoppeld na een herstart. Zodra een bestandssysteem door een leverende extensie is gekoppeld , blijft het dus behouden totdat de extensie wordt verwijderd of de extensie de unmount -methode aanroept.

Typen

AbortRequestedOptions

Eigenschappen

Action

Eigenschappen

AddWatcherRequestedOptions

Eigenschappen

Change

Eigenschappen

ChangeType

Type wijziging dat is gedetecteerd in de waargenomen directory.

Enum

CloseFileRequestedOptions

Eigenschappen

CloudFileInfo

Eigenschappen

CloudIdentifier

Eigenschappen

CommonActionId

Lijst met veelgebruikte acties. "SHARE" is voor het delen van bestanden met anderen. "SAVE_FOR_OFFLINE" voor vastzetten (opslaan voor offline toegang). "OFFLINE_NOT_NECESSARY" om aan te geven dat het bestand niet meer opgeslagen hoeft te worden voor offline toegang. Gebruikt door onGetActionsRequested en onExecuteActionRequested .

Enum

"OPSLAAN VOOR OFFLINE"

"OFFLINE_NIET_NODIG"

"DEEL"

ConfigureRequestedOptions

Eigenschappen

CopyEntryRequestedOptions

Eigenschappen

CreateDirectoryRequestedOptions

Eigenschappen

CreateFileRequestedOptions

Eigenschappen

DeleteEntryRequestedOptions

Eigenschappen

EntryMetadata

Eigenschappen

ExecuteActionRequestedOptions

Eigenschappen

FileSystemInfo

Eigenschappen

GetActionsRequestedOptions

Eigenschappen

GetMetadataRequestedOptions

Eigenschappen

MountOptions

Eigenschappen

MoveEntryRequestedOptions

Eigenschappen

NotifyOptions

Eigenschappen

OpenedFile

Eigenschappen

OpenFileMode

Manier om een bestand te openen. Gebruikt door onOpenFileRequested .

Enum

OpenFileRequestedOptions

Eigenschappen

ProviderError

Foutcodes die worden gebruikt bij het verstrekken van extensies als reactie op verzoeken en bij fouten bij het aanroepen van API-methoden. Voor succes moet "OK" worden gebruikt.

Enum

"OK"

"MISLUKT"

"IN_GEBRUIK"

"BESTAAT"

"NIET_GEVONDEN"

"TOEGANG_GEWEIGERD"

"TE_VEEL_GEOPEND"

"GEEN_GEHEUGEN"

"GEEN_RUIMTE"

"GEEN_MAP"

"ONGELDIGE_BEWERKING"

"BEVEILIGING"

"ABORTEREN"

"GEEN_BESTAND"

"NIET_LEEG"

"ONGELDIGE_URL"

"IO"

ReadDirectoryRequestedOptions

Eigenschappen

ReadFileRequestedOptions

Eigenschappen

RemoveWatcherRequestedOptions

Eigenschappen

TruncateRequestedOptions

Eigenschappen

UnmountOptions

Eigenschappen

UnmountRequestedOptions

Eigenschappen

Watcher

Eigenschappen

WriteFileRequestedOptions

Eigenschappen

Methoden

get()

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

Geeft informatie terug over een bestandssysteem met de doorgegeven fileSystemId .

Parameters

Retourneren

getAll()

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

Retourneert alle bestandssystemen die door de extensie zijn gekoppeld.

Retourneren

mount()

chrome.fileSystemProvider.mount(
  options: MountOptions,
): Promise

Koppelt een bestandssysteem met de opgegeven fileSystemId en displayName . displayName wordt weergegeven in het linkerpaneel van de Bestanden-app. displayName kan alle tekens bevatten, inclusief '/', maar mag geen lege tekenreeks zijn. displayName moet beschrijvend zijn, maar hoeft niet uniek te zijn. De fileSystemId mag geen lege tekenreeks zijn.

Afhankelijk van het type bestandssysteem dat wordt gekoppeld, moet de source correct worden ingesteld.

Indien er een fout optreedt, wordt runtime.lastError ingesteld met een bijbehorende foutcode.

Parameters

Retourneren

notify()

chrome.fileSystemProvider.notify(
  options: NotifyOptions,
): Promise

Geeft een melding over wijzigingen in de bewaakte directory op observedPath in recursive modus. Als het bestandssysteem is gekoppeld met supportsNotifyTag , moet de tag worden opgegeven en worden alle wijzigingen sinds de laatste melding altijd gerapporteerd, zelfs als het systeem is afgesloten. De laatste tag kan worden verkregen met getAll .

Om dit te kunnen gebruiken, moet de manifestoptie file_system_provider.notify op true worden ingesteld.

De waarde van tag kan elke tekenreeks zijn die uniek is per aanroep, zodat de laatst geregistreerde melding kan worden geïdentificeerd. Bijvoorbeeld: als de leverende extensie start na een herstart en de tag van de laatst geregistreerde melding gelijk is aan "123", dan moet deze notify aanroepen voor alle wijzigingen die zijn aangebracht sinds de wijziging die als "123" is getagd. Dit mag geen lege tekenreeks zijn.

Niet alle providers kunnen een tag verstrekken, maar als het bestandssysteem een changelog heeft, kan de tag bijvoorbeeld een wijzigingsnummer of een revisienummer zijn.

Houd er rekening mee dat als een bovenliggende map wordt verwijderd, alle onderliggende items ook worden verwijderd. Als deze worden bewaakt, moet de API hiervan op de hoogte worden gesteld. Ook als een map wordt hernoemd, worden alle onderliggende items daadwerkelijk verwijderd, omdat er geen items meer onder hun oorspronkelijke paden staan.

Indien er een fout optreedt, wordt runtime.lastError voorzien van een bijbehorende foutcode.

Parameters

Retourneren

unmount()

chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
): Promise

Ontkoppelt een bestandssysteem met de opgegeven fileSystemId . Deze moet worden aangeroepen nadat onUnmountRequested is aangeroepen. De leverende extensie kan ook besluiten om ontkoppelen uit te voeren als er niet om is gevraagd (bijvoorbeeld in geval van een verbroken verbinding of een bestandsfout).

Indien er een fout optreedt, wordt runtime.lastError ingesteld met een bijbehorende foutcode.

Parameters

Retourneren

Evenementen

onAbortRequested

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

Wordt gegenereerd wanneer een bewerking met operationRequestId wordt aangevraagd om deze te annuleren. De bewerking die met operationRequestId wordt uitgevoerd, moet onmiddellijk worden gestopt en successCallback van deze afbrekingsaanvraag moet worden uitgevoerd. Als het afbreken mislukt, moet errorCallback worden aangeroepen. Let op: callbacks van de afgebroken bewerking mogen niet worden aangeroepen, omdat deze worden genegeerd. Ondanks het aanroepen van errorCallback kan de aanvraag geforceerd worden afgebroken.

Parameters

onAddWatcherRequested

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

Wordt gegenereerd wanneer er een nieuwe directory watcher wordt aangevraagd. Als er een fout optreedt, moet errorCallback worden aangeroepen.

Parameters

onCloseFileRequested

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

Deze foutmelding treedt op wanneer een bestand dat eerder met openRequestId is geopend, moet worden gesloten.

Parameters

onConfigureRequested

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

Wordt gegenereerd wanneer een configuratievenster voor fileSystemId wordt opgevraagd. Als dit wordt afgehandeld, moet de optie file_system_provider.configurable manfiest op true worden ingesteld.

Parameters

onCopyEntryRequested

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

Wordt gegenereerd wanneer het kopiëren van een item (recursief indien het een directory betreft) wordt aangevraagd. Als er een fout optreedt, moet errorCallback worden aangeroepen.

Parameters

onCreateDirectoryRequested

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

Wordt gegenereerd wanneer een directory wordt aangemaakt. De bewerking moet mislukken met de EXISTS-fout als de doeldirectory al bestaat. Als recursive true is, moeten alle ontbrekende directory's in het directorypad worden aangemaakt.

Parameters

onCreateFileRequested

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

Wordt gegenereerd wanneer een bestand wordt aangemaakt. Als het bestand al bestaat, moet errorCallback worden aangeroepen met de foutcode "EXISTS" .

Parameters

onDeleteEntryRequested

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

Wordt gegenereerd wanneer het verwijderen van een item wordt aangevraagd. Als recursive true is en het item een directory betreft, moeten alle items daarin ook recursief worden verwijderd.

Parameters

onExecuteActionRequested

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

Wordt gegenereerd wanneer een actie voor een set bestanden of mappen wordt aangevraagd. Nadat de actie is voltooid, moet successCallback worden aangeroepen. Bij een fout moet errorCallback worden aangeroepen.

Parameters

onGetActionsRequested

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

Wordt gegenereerd wanneer een lijst met acties voor een set bestanden of mappen op entryPaths wordt opgevraagd. Alle geretourneerde acties moeten van toepassing zijn op elk item. Als er geen dergelijke acties zijn, moet een lege array worden geretourneerd. De acties moeten worden geretourneerd met de aanroep successCallback . In geval van een fout moet errorCallback worden aangeroepen.

Parameters

onGetMetadataRequested

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

Wordt gegenereerd wanneer metadata van een bestand of directory op entryPath wordt opgevraagd. De metadata moet worden geretourneerd met de aanroep successCallback . In geval van een fout moet errorCallback worden aangeroepen.

Parameters

onMountRequested

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

Wordt gegenereerd wanneer een dialoogvenster voor het koppelen van een nieuw bestandssysteem wordt aangevraagd. Als de extensie/app een bestandshandler is, mag deze gebeurtenis niet worden verwerkt. In plaats daarvan moet app.runtime.onLaunched worden verwerkt om nieuwe bestandssystemen te koppelen wanneer een bestand wordt geopend. Voor meerdere koppelingen moet de manifestoptie file_system_provider.multiple_mounts op true worden ingesteld.

Parameters

onMoveEntryRequested

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

Wordt gegenereerd wanneer een item (recursief indien het een directory betreft) wordt verplaatst. Als er een fout optreedt, moet errorCallback worden aangeroepen.

Parameters

onOpenFileRequested

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

Wordt gegenereerd wanneer een bestand op filePath wordt geopend. Als het bestand niet bestaat, mislukt de bewerking. Het maximale aantal bestanden dat tegelijk kan worden geopend, kan worden opgegeven met MountOptions .

Parameters

onReadDirectoryRequested

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

Wordt gegenereerd wanneer de inhoud van een directory op directoryPath wordt opgevraagd. De resultaten moeten in delen worden geretourneerd door successCallback meerdere keren aan te roepen. In geval van een fout moet errorCallback worden aangeroepen.

Parameters

onReadFileRequested

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

Wordt gegenereerd wanneer de inhoud van een eerder geopend bestand met openRequestId wordt opgevraagd. De resultaten moeten in delen worden geretourneerd door successCallback meerdere keren aan te roepen. In geval van een fout moet errorCallback worden aangeroepen.

Parameters

onRemoveWatcherRequested

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

Wordt aangeroepen wanneer de watcher verwijderd moet worden. Als er een fout optreedt, moet errorCallback worden aangeroepen.

Parameters

onTruncateRequested

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

Wordt gegenereerd wanneer een bestand wordt afgekapt tot de gewenste lengte. Als er een fout optreedt, moet errorCallback worden aangeroepen.

Parameters

onUnmountRequested

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

Wordt gegenereerd wanneer unmounten voor het bestandssysteem met de fileSystemId identificatie wordt aangevraagd. In het antwoord moet de unmount API-methode samen met successCallback worden aangeroepen. Als unmounten niet mogelijk is (bijvoorbeeld vanwege een in behandeling zijnde bewerking), moet errorCallback worden aangeroepen.

Parameters

onWriteFileRequested

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

Wordt gegenereerd wanneer er een aanvraag wordt gedaan om inhoud te schrijven naar een bestand dat eerder is geopend met openRequestId .

Parameters

Tenzij anders vermeld, is de content op deze pagina gelicentieerd onder de Creative Commons Attribution 4.0-licentie en zijn codevoorbeelden gelicentieerd onder de Apache 2.0-licentie. Voor meer informatie raadpleegt u het Google Developers-sitebeleid. Java is een gedeponeerd handelsmerk van Oracle en/of diens aangesloten entiteiten.

Last updated 2025-08-11 UTC.