chrome.fileSystem

Beschrijving

Gebruik de chrome.fileSystem API om het lokale bestandssysteem van de gebruiker te maken, te lezen, te navigeren en ernaar te schrijven. Met deze API kunnen Chrome-apps lezen en schrijven naar een door de gebruiker geselecteerde locatie. Een teksteditor kan de API bijvoorbeeld gebruiken om lokale documenten te lezen en te schrijven. Alle fouten worden gemeld via chrome.runtime.lastError.

Machtigingen

fileSystem

Beschikbaarheid

Alleen voorgrond

Typen

AcceptOption

Eigenschappen

  • beschrijving

    string optioneel

    Dit is de optionele tekstuele beschrijving voor deze optie. Indien niet aanwezig, wordt er automatisch een beschrijving gegenereerd; meestal met een uitgebreide lijst met geldige extensies (bijvoorbeeld "text/html" kan worden uitgebreid tot "*.html, *.htm").

  • extensies

    string[] optioneel

    Te accepteren extensies, bijvoorbeeld "jpg", "gif", "crx".

  • mimeTypes

    string[] optioneel

    Te accepteren mime-typen, bijvoorbeeld "image/jpeg" of "audio/*". Een van de mimeTypes of extensies moet minstens één geldig element bevatten.

ChooseEntryOptions

Eigenschappen

  • accepteert

    AcceptOption [] optioneel

    De optionele lijst met acceptatieopties voor deze bestandsopener. Elke optie wordt als een unieke groep aan de eindgebruiker gepresenteerd.

  • accepteertAlleTypen

    boolean optioneel

    Of alle bestandstypen geaccepteerd moeten worden, naast de opties die zijn opgegeven in het argument 'accepts'. De standaardwaarde is 'true'. Als het veld 'accepts' niet is ingesteld of geen geldige waarden bevat, wordt dit altijd teruggezet naar 'true'.

  • accepteertMeerdere

    boolean optioneel

    Of meerdere bestanden geaccepteerd moeten worden. Dit wordt alleen ondersteund voor openFile en openWritableFile. De callback naar chooseEntry wordt aangeroepen met een lijst met items als deze optie is ingesteld op true. Anders wordt deze aangeroepen met één item.

  • voorgestelde naam

    string optioneel

    De voorgestelde bestandsnaam die aan de gebruiker wordt gepresenteerd als standaardnaam om te lezen of schrijven. Dit is optioneel.

  • type

    ChooseEntryType optioneel

    Het type prompt dat moet worden weergegeven. De standaardwaarde is 'openFile'.

ChooseEntryType

Enum

"openBestand"
Vraagt de gebruiker een bestaand bestand te openen en retourneert bij succes een FileEntry. Vanaf Chrome 31 is de FileEntry schrijfbaar als de applicatie schrijfrechten heeft onder 'fileSystem'; anders is de FileEntry alleen-lezen.

"openWritableFile"
Vraagt de gebruiker een bestaand bestand te openen en retourneert bij succes een schrijfbare FileEntry. Aanroepen met dit type mislukken met een runtime-fout als de applicatie geen schrijfrechten heeft onder 'fileSystem'.

"bestand opslaan"
Vraagt de gebruiker een bestaand bestand of een nieuw bestand te openen en retourneert bij succes een schrijfbare FileEntry. Aanroepen van dit type mislukken met een runtime-fout als de applicatie geen schrijfmachtiging heeft onder 'bestandssysteem'.

"openDirectory"
Vraagt de gebruiker een directory te openen en retourneert bij succes een DirectoryEntry. Aanroepen van dit type mislukken met een runtime-fout als de applicatie geen 'directory'-machtiging heeft onder 'fileSystem'. Als de applicatie wel de 'write'-machtiging heeft onder 'fileSystem', is de geretourneerde DirectoryEntry schrijfbaar; anders is deze alleen-lezen. Nieuw in Chrome 31.

RequestFileSystemOptions

Chroom 44+

Eigenschappen

  • volume-ID

    snaar

    De ID van het opgevraagde volume.

  • beschrijfbaar

    boolean optioneel

    Of het gevraagde bestandssysteem schrijfbaar moet zijn. Standaard is dit alleen-lezen.

Volume

Chroom 44+

Eigenschappen

  • volume-ID

    snaar

  • beschrijfbaar

    Booleaanse

VolumeListChangedEvent

Chroom 44+

Eigenschappen

Methoden

chooseEntry()

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

Vraag de gebruiker om een bestand of map te kiezen.

Parameters

  • opties

    ChooseEntryOptions optioneel

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

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

    • toegang

      Toegang optioneel

    • bestandsvermeldingen

      FileEntry[] optioneel

getDisplayPath()

Belofte
chrome.fileSystem.getDisplayPath(
  entry: Entry,
  callback?: function,
): Promise<string>

Haal het weergavepad van een Entry-object op. Het weergavepad is gebaseerd op het volledige pad van het bestand of de map op het lokale bestandssysteem, maar kan leesbaarder worden gemaakt voor weergavedoeleinden.

Parameters

  • toegang

    Toegang

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (displayPath: string) => void

    • weergavepad

      snaar

Retourneren

  • Belofte<string>

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getVolumeList()

BelofteChrome 44+
chrome.fileSystem.getVolumeList(
  callback?: function,
): Promise<Volume[] | undefined>

Retourneert een lijst met volumes die beschikbaar zijn voor requestFileSystem() . De manifestmachtiging "fileSystem": {"requestFileSystem"} is vereist. Alleen beschikbaar voor kiosk-apps die in de kiosksessie worden uitgevoerd. In geval van een fout worden volumes ongedefinieerd en wordt chrome.runtime.lastError ingesteld.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (volumes?: Volume[]) => void

Retourneren

  • Belofte< Volume [] | undefined>

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getWritableEntry()

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

Haal een schrijfbare Entry op van een andere Entry. Deze aanroep mislukt met een runtime-fout als de applicatie geen schrijfrechten heeft onder 'fileSystem'. Als de entry een DirectoryEntry is, mislukt deze aanroep als de applicatie geen directoryrechten heeft onder 'fileSystem'.

Parameters

  • toegang

    Toegang

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (entry: Entry) => void

    • toegang

      Toegang

isRestorable()

Belofte
chrome.fileSystem.isRestorable(
  id: string,
  callback?: function,
): Promise<boolean>

Geeft terug of de app toestemming heeft om de invoer met de opgegeven id te herstellen.

Parameters

  • id

    snaar

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (isRestorable: boolean) => void

    • isHerstelbaar

      Booleaanse

Retourneren

  • Belofte<boolean>

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

isWritableEntry()

Belofte
chrome.fileSystem.isWritableEntry(
  entry: Entry,
  callback?: function,
): Promise<boolean>

Geeft aan of dit item schrijfbaar is of niet.

Parameters

  • toegang

    Toegang

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (isWritable: boolean) => void

    • isWritable

      Booleaanse

Retourneren

  • Belofte<boolean>

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

requestFileSystem()

BelofteChrome 44+
chrome.fileSystem.requestFileSystem(
  options: RequestFileSystemOptions,
  callback?: function,
): Promise<FileSystem | undefined>

Vraagt toegang tot een bestandssysteem voor een volume dat wordt weergegeven door options.volumeId . Als options.writable is ingesteld op true, is het bestandssysteem schrijfbaar. Anders is het alleen-lezen. De optie writable vereist de machtiging "fileSystem": {"write"} in het manifest. Alleen beschikbaar voor kiosk-apps die in een kiosksessie worden uitgevoerd. Voor handmatig gestarte kioskmodus wordt een bevestigingsvenster weergegeven boven het actieve app-venster. In geval van een fout wordt fileSystem ongedefinieerd en wordt chrome.runtime.lastError ingesteld.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (fileSystem?: FileSystem) => void

    • bestandssysteem

      Bestandssysteem optioneel

Retourneren

  • Promise<Bestandssysteem | undefined>

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

restoreEntry()

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

Retourneert het bestandsitem met de opgegeven id als het kan worden hersteld. Anders mislukt deze aanroep met een runtime-fout.

Parameters

  • id

    snaar

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (entry: Entry) => void

    • toegang

      Toegang

retainEntry()

chrome.fileSystem.retainEntry(
  entry: Entry,
): string

Retourneert een id die kan worden doorgegeven aan restoreEntry om opnieuw toegang te krijgen tot een bepaald bestandsitem. Alleen de 500 meest recent gebruikte items worden bewaard, waarbij aanroepen van retainEntry en restoreEntry als gebruik tellen. Als de app de machtiging 'retainEntries' heeft onder 'fileSystem', worden items voor onbepaalde tijd bewaard. Anders worden items alleen bewaard zolang de app actief is en na herstarts.

Parameters

  • toegang

    Toegang

Retourneren

  • snaar

Evenementen

onVolumeListChanged

Chroom 44+
chrome.fileSystem.onVolumeListChanged.addListener(
  callback: function,
)

Wordt aangeroepen wanneer een lijst met beschikbare volumes wordt gewijzigd.

Parameters