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-app kan de API bijvoorbeeld gebruiken om lokale documenten te lezen en te schrijven. Alle fouten worden gemeld via chrome.runtime.lastError.

Rechten

fileSystem

Beschikbaarheid

Alleen voorgrond

Typen

AcceptOption

Eigenschappen

  • beschrijving

    tekenreeks optioneel

    Dit is de optionele tekstbeschrijving voor deze optie. Als er geen beschrijving is, wordt er automatisch een gegenereerd. Deze bevat meestal een uitgebreide lijst met geldige extensies (text/html kan bijvoorbeeld worden uitgebreid naar *.html, *.htm).

  • extensies

    string[] optioneel

    Extensies die moeten worden geaccepteerd, bijvoorbeeld jpg, gif, crx.

  • mimeTypes

    string[] optioneel

    MIME-typen die moeten worden geaccepteerd, 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 aan de eindgebruiker gepresenteerd als een unieke groep.

  • acceptsAllTypes

    booleaans optioneel

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

  • acceptsMultiple

    booleaans optioneel

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

  • suggestedName

    tekenreeks optioneel

    De voorgestelde bestandsnaam die aan de gebruiker wordt getoond als de standaardnaam om op te slaan. Dit is optioneel en is alleen van toepassing op saveFile.

  • type

    ChooseEntryType optioneel

    Type prompt dat moet worden getoond. De standaardwaarde is 'openFile'.

ChooseEntryType

Enum

"openFile"
Vraagt de gebruiker een bestaand bestand te openen en retourneert een FileEntry als dit lukt. Vanaf Chrome 31 is de FileEntry beschrijfbaar als de app het recht 'write' heeft onder 'fileSystem'. Anders is de FileEntry alleen-lezen.

"openWritableFile"
Vraagt de gebruiker een bestaand bestand te openen en retourneert een beschrijfbare FileEntry als dit lukt. Aanroepen met dit type mislukken met een runtimefout als de app niet het recht 'write' heeft onder 'fileSystem'.

"saveFile"
Vraagt de gebruiker een bestaand bestand of een nieuw bestand te openen en retourneert een beschrijfbare FileEntry als dit lukt. Aanroepen met dit type mislukken met een runtimefout als de app niet het recht 'write' heeft onder 'fileSystem'.

"openDirectory"
Vraagt de gebruiker een directory te openen en retourneert een DirectoryEntry als dit lukt. Gesprekken met dit type mislukken met een runtime-fout als de app niet het recht 'directory' heeft onder 'fileSystem'. Als de app het recht 'write' heeft onder 'fileSystem', kan er naar de geretourneerde DirectoryEntry worden geschreven. Anders is deze alleen-lezen. Nieuw in Chrome 31.

RequestFileSystemOptions

Chrome 44+

Eigenschappen

  • volumeId

    tekenreeks

    De ID van het aangevraagde volume.

  • schrijfbaar

    booleaans optioneel

    Of het aangevraagde bestandssysteem beschrijfbaar moet zijn. De standaardinstelling is alleen-lezen.

Volume

Chrome 44+

Eigenschappen

  • volumeId

    tekenreeks

  • schrijfbaar

    booleaans

VolumeListChangedEvent

Chrome 44+

Eigenschappen

Methoden

chooseEntry()

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

Vraag de gebruiker om een bestand of directory te kiezen.

Parameters

  • opties

    ChooseEntryOptions optioneel

  • callback

    functie

    De parameter callback ziet er zo uit: 

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

    • vermelding

      Invoer optioneel

    • fileEntries

      FileEntry[] optioneel

getDisplayPath()

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

Het weergavepad van een Entry-object ophalen. Het weergavepad is gebaseerd op het volledige pad van het bestand of de directory in het lokale bestandssysteem, maar kan beter leesbaar worden gemaakt voor weergavedoeleinden.

Parameters

  • vermelding

    Toegang

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (displayPath: string) => void

    • displayPath

      tekenreeks

Retourzendingen

  • Promise<string>

    Chrome 117+

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

getVolumeList()

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

Retourneert een lijst met beschikbare delen voor requestFileSystem(). Het manifestrecht "fileSystem": {"requestFileSystem"} is vereist. Alleen beschikbaar voor kiosk-apps die worden uitgevoerd in de kiosksessie. In het geval van een fout is volumes niet gedefinieerd en wordt chrome.runtime.lastError ingesteld.

Parameters

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (volumes?: Volume[]) => void

Retourzendingen

  • Promise<Volume[] | undefined>

    Chrome 117+

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

getWritableEntry()

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

Een beschrijfbare invoer ophalen uit een andere invoer. Deze aanroep mislukt met een runtimefout als de app niet het recht 'write' heeft onder 'fileSystem'. Als de invoer een DirectoryEntry is, mislukt deze aanroep als de app niet het recht 'directory' onder 'fileSystem' heeft.

Parameters

  • vermelding

    Toegang

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (entry: Entry) => void

    • vermelding

      Toegang

isRestorable()

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

Retourneert of de app rechten heeft om het item met de opgegeven ID te herstellen.

Parameters

  • id

    tekenreeks

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (isRestorable: boolean) => void

    • isRestorable

      booleaans

Retourzendingen

  • Promise<boolean>

    Chrome 117+

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

isWritableEntry()

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

Hiermee wordt bepaald of dit item beschrijfbaar is of niet.

Parameters

  • vermelding

    Toegang

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (isWritable: boolean) => void

    • isWritable

      booleaans

Retourzendingen

  • Promise<boolean>

    Chrome 117+

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

requestFileSystem()

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

Vraagt toegang tot een bestandssysteem voor een volume dat wordt vertegenwoordigd door options.volumeId. Als options.writable is ingesteld op True, kan er naar het bestandssysteem worden geschreven. Anders is het alleen-lezen. Voor de optie writable is het recht "fileSystem": {"write"} in het manifest vereist. Alleen beschikbaar voor kiosk-apps die worden uitgevoerd in een kiosksessie. In de kioskmodus voor handmatig starten wordt een bevestigingsdialoogvenster getoond boven het actieve app-venster. In het geval van een fout is fileSystem niet gedefinieerd en wordt chrome.runtime.lastError ingesteld.

Parameters

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (fileSystem?: FileSystem) => void

    • fileSystem

      FileSystem optioneel

Retourzendingen

  • Promise<FileSystem | undefined>

    Chrome 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 de bestandsvermelding met de opgegeven ID als deze kan worden hersteld. Anders mislukt deze aanroep met een runtimefout.

Parameters

  • id

    tekenreeks

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (entry: Entry) => void

    • vermelding

      Toegang

retainEntry()

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

Retourneert een ID die kan worden doorgegeven aan restoreEntry om weer toegang te krijgen tot een bepaalde bestandsvermelding. Alleen de 500 meest recent gebruikte items worden bewaard, waarbij aanroepen van retainEntry en restoreEntry als gebruik tellen. Als de app het recht retainEntries heeft onder fileSystem, worden items voor onbepaalde tijd bewaard. Anders worden items alleen bewaard terwijl de app actief is en als deze opnieuw wordt opgestart.

Parameters

  • vermelding

    Toegang

Retourzendingen

  • tekenreeks

Evenementen

onVolumeListChanged

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

Wordt aangeroepen als een lijst met beschikbare volumes wordt gewijzigd.

Parameters