Beschrijving
Gebruik de chrome.fileSystem
API om het lokale bestandssysteem van de gebruiker te maken, lezen, navigeren en ernaar te schrijven. Met deze API kunnen Chrome-apps lezen van 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
Soorten
AcceptOption
Eigenschappen
- beschrijving
tekenreeks optioneel
Dit is de optionele tekstbeschrijving voor deze optie. Indien niet aanwezig wordt er automatisch een omschrijving gegenereerd; bevat meestal een uitgebreide lijst met geldige extensies (bijvoorbeeld "text/html" kan worden uitgebreid naar "*.html, *.htm").
- extensies
tekenreeks[] optioneel
Te accepteren extensies, bijvoorbeeld "jpg", "gif", "crx".
- mime-typen
tekenreeks[] optioneel
Te accepteren mime-typen, bijvoorbeeld "image/jpeg" of "audio/*". Eén van 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.
- accepteertAllTypes
Booleaans optioneel
Of alle bestandstypen moeten worden geaccepteerd, naast de opties die zijn opgegeven in het accept-argument. De standaardwaarde is waar. Als het acceptatieveld niet is ingesteld of geen geldige gegevens bevat, wordt dit altijd opnieuw ingesteld op waar.
- accepteertmeerdere
Booleaans optioneel
Of u meerdere bestanden wilt accepteren. Dit wordt alleen ondersteund voor openFile en openWritableFile. De callback naar ChooseEntry wordt aangeroepen met een lijst met vermeldingen als deze is ingesteld op true. Anders wordt het met een enkele invoer aangeroepen.
- voorgestelde naam
tekenreeks optioneel
De voorgestelde bestandsnaam die aan de gebruiker wordt gepresenteerd als de standaardnaam om te lezen of te schrijven. Dit is optioneel.
- type
KiesEntryType optioneel
Type de prompt die moet worden weergegeven. De standaardwaarde is 'openFile'.
ChooseEntryType
Enum
"open bestand" "openWritableFile" "sla bestand op" "openDirectory"
Vraagt de gebruiker een bestaand bestand te openen en retourneert een FileEntry als dit is gelukt. Vanaf Chrome 31 is de FileEntry beschrijfbaar als de applicatie de 'schrijf'-machtiging heeft onder 'fileSystem'; anders is de FileEntry alleen-lezen.
Vraagt de gebruiker een bestaand bestand te openen en retourneert bij succes een beschrijfbare FileEntry. Aanroepen met dit type mislukken met een runtime-fout als de toepassing niet over de schrijfmachtiging onder 'fileSystem' beschikt.
Vraagt de gebruiker om een bestaand bestand of een nieuw bestand te openen en retourneert bij succes een beschrijfbare FileEntry. Aanroepen met dit type mislukken met een runtime-fout als de toepassing niet over de schrijfmachtiging onder 'fileSystem' beschikt.
Vraagt de gebruiker om een map te openen en retourneert een DirectoryEntry als dit is gelukt. Aanroepen met dit type mislukken met een runtimefout als de toepassing niet over de machtiging 'directory' onder 'fileSystem' beschikt. Als de toepassing de machtiging 'schrijven' heeft onder 'fileSystem', zal de geretourneerde DirectoryEntry beschrijfbaar zijn; anders is het alleen-lezen. Nieuw in Chrome 31.
RequestFileSystemOptions
Eigenschappen
- volumeId
snaar
De ID van het aangevraagde volume.
- beschrijfbaar
Booleaans optioneel
Of het gevraagde bestandssysteem beschrijfbaar moet zijn. De standaardinstelling is alleen-lezen.
Volume
Eigenschappen
- volumeId
snaar
- beschrijfbaar
Booleaans
VolumeListChangedEvent
Eigenschappen
- volumes
Volume []
Methoden
chooseEntry()
chrome.fileSystem.chooseEntry(
options?: ChooseEntryOptions,
callback: function,
)
Vraag de gebruiker om een bestand of map te kiezen.
Parameters
- opties
KiesEntryOptions optioneel
- Bel terug
functie
De
callback
parameter ziet er als volgt uit:(entry?: Entry, fileEntries?: FileEntry[]) => void
- binnenkomst
Toegang optioneel
- bestandsinvoer
FileEntry[] optioneel
getDisplayPath()
chrome.fileSystem.getDisplayPath(
entry: Entry,
callback?: function,
)
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 voor weergavedoeleinden beter leesbaar worden gemaakt.
Parameters
- binnenkomst
Binnenkomst
- Bel terug
functie optioneel
De
callback
parameter ziet er als volgt uit:(displayPath: string) => void
- weergavepad
snaar
Geeft terug
Beloof<tekenreeks>
Chroom 117+Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.
getVolumeList()
chrome.fileSystem.getVolumeList(
callback?: function,
)
Retourneert een lijst met volumes die beschikbaar zijn voor requestFileSystem()
. De manifesttoestemming "fileSystem": {"requestFileSystem"}
is vereist. Alleen beschikbaar voor kiosk-apps die tijdens de kiosksessie worden uitgevoerd. In geval van een fout zijn volumes
niet gedefinieerd en wordt chrome.runtime.lastError
ingesteld.
Parameters
Geeft terug
Belofte< Volume [] | ongedefinieerd>
Chroom 117+Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.
getWritableEntry()
chrome.fileSystem.getWritableEntry(
entry: Entry,
callback: function,
)
Verkrijg een beschrijfbare inzending van een andere inzending. Deze aanroep mislukt met een runtime-fout als de toepassing niet over de 'schrijf'-machtiging onder 'fileSystem' beschikt. Als de invoer een DirectoryEntry is, mislukt deze aanroep als de toepassing niet over de machtiging 'directory' onder 'fileSystem' beschikt.
Parameters
- binnenkomst
Binnenkomst
- Bel terug
functie
De
callback
parameter ziet er als volgt uit:(entry: Entry) => void
- binnenkomst
Binnenkomst
isRestorable()
chrome.fileSystem.isRestorable(
id: string,
callback?: function,
)
Geeft terug of de app toestemming heeft om het item met de opgegeven ID te herstellen.
Parameters
- ID kaart
snaar
- Bel terug
functie optioneel
De
callback
parameter ziet er als volgt uit:(isRestorable: boolean) => void
- isherstelbaar
Booleaans
Geeft terug
Beloof<boolean>
Chroom 117+Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.
isWritableEntry()
chrome.fileSystem.isWritableEntry(
entry: Entry,
callback?: function,
)
Krijgt of dit bericht beschrijfbaar is of niet.
Parameters
- binnenkomst
Binnenkomst
- Bel terug
functie optioneel
De
callback
parameter ziet er als volgt uit:(isWritable: boolean) => void
- isschrijfbaar
Booleaans
Geeft terug
Beloof<boolean>
Chroom 117+Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.
requestFileSystem()
chrome.fileSystem.requestFileSystem(
options: RequestFileSystemOptions,
callback?: function,
)
Vraagt toegang tot een bestandssysteem voor een volume dat wordt weergegeven door options.volumeId
. Als options.writable
is ingesteld op true, dan is het bestandssysteem beschrijfbaar. Anders is het alleen-lezen. Voor de writable
optie is de machtiging "fileSystem": {"write"}
in het manifest vereist. Alleen beschikbaar voor kiosk-apps die in een kiosksessie worden uitgevoerd. Voor de handmatig gestarte kioskmodus wordt een bevestigingsvenster weergegeven bovenaan het actieve app-venster. In geval van een fout is fileSystem
niet gedefinieerd en wordt chrome.runtime.lastError
ingesteld.
Parameters
- opties
- Bel terug
functie optioneel
De
callback
parameter ziet er als volgt uit:(fileSystem?: FileSystem) => void
- bestandssysteem
Bestandssysteem optioneel
Geeft terug
Belofte<Bestandssysteem | ongedefinieerd>
Chroom 117+Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.
restoreEntry()
chrome.fileSystem.restoreEntry(
id: string,
callback: function,
)
Retourneert de bestandsinvoer met de opgegeven ID als deze kan worden hersteld. Anders mislukt deze aanroep en treedt er een runtimefout op.
Parameters
- ID kaart
snaar
- Bel terug
functie
De
callback
parameter ziet er als volgt uit:(entry: Entry) => void
- binnenkomst
Binnenkomst
retainEntry()
chrome.fileSystem.retainEntry(
entry: Entry,
)
Retourneert een ID die kan worden doorgegeven aan herstelEntry om weer toegang te krijgen tot een bepaald bestandsitem. Alleen de 500 meest recent gebruikte vermeldingen worden bewaard, waarbij aanroepen van retainEntry en RestoreEntry als gebruik tellen. Als de app de machtiging 'retainEntries' heeft onder 'fileSystem', worden gegevens voor onbepaalde tijd bewaard. Anders worden de gegevens alleen bewaard als de app actief is en als de app opnieuw wordt opgestart.
Parameters
- binnenkomst
Binnenkomst
Geeft terug
snaar
Evenementen
onVolumeListChanged
chrome.fileSystem.onVolumeListChanged.addListener(
callback: function,
)
Wordt opgeroepen wanneer een lijst met beschikbare volumes wordt gewijzigd.
Parameters
- Bel terug
functie
De
callback
parameter ziet er als volgt uit:(event: VolumeListChangedEvent) => void
- evenement