Descrizione
Utilizza l'API chrome.fileSystem
per creare, leggere, navigare e scrivere nel file system locale dell'utente. Con questa API, le app di Chrome possono leggere e scrivere in una posizione selezionata dall'utente. Ad esempio, un'app di editor di testo può utilizzare l'API per leggere e scrivere documenti locali. Tutti gli errori vengono informati tramite chrome.runtime.lastError.
Autorizzazioni
fileSystem
Disponibilità
Tipi
AcceptOption
Proprietà
-
descrizione
stringa facoltativo
Questa è la descrizione di testo facoltativa per l'opzione. Se non è presente, verrà generata automaticamente una descrizione; in genere contiene un elenco ampliato di estensioni valide (ad es. "text/html" può espandersi in "*.html, *.htm").
-
estensioni
string[] facoltativo
Estensioni da accettare, ad esempio "jpg", "gif", "crx".
-
mimeTypes
string[] facoltativo
Tipi MIME da accettare, ad esempio "image/jpeg" o "audio/*". Uno dei tipi mimeType o delle estensioni deve contenere almeno un elemento valido.
ChooseEntryOptions
Proprietà
-
accetta
AcceptOption[] facoltativo
L'elenco facoltativo di opzioni di accettazione per questo apri file. Ogni opzione viene presentata come gruppo univoco all'utente finale.
-
acceptsAllTypes
booleano facoltativo
Se accettare tutti i tipi di file, oltre alle opzioni specificate nell'argomento accetta. Il valore predefinito è true. Se il campo Accept non viene impostato o non contiene voci valide, il campo viene sempre reimpostato su true.
-
acceptsMultiple
booleano facoltativo
Se accettare più file. Questa opzione è supportata solo per openFile e openWritableFile. Il callback per selectEntry verrà chiamato con un elenco di voci se questo è impostato su true. In caso contrario, verrà chiamata con una singola voce.
-
suggestedName
stringa facoltativo
Il nome file suggerito che verrà presentato all'utente come nome predefinito per la lettura o la scrittura. Questa opzione è facoltativa.
-
Tipo
Facoltativo ChooseEntryType
Tipo di prompt da mostrare. Il valore predefinito è "openFile".
ChooseEntryType
Enum
"openFile"
Richiede all'utente di aprire un file esistente e restituisce una voce di file in caso di esito positivo. A partire da Chrome 31, la FileEntry sarà accessibile in scrittura se l'applicazione dispone dell'autorizzazione di "scrittura" in "fileSystem"; altrimenti, il FileEntry sarà di sola lettura.
"openWritableFile"
Richiede all'utente di aprire un file esistente e restituisce una voce FileEntry scrivibile se l'operazione ha esito positivo. Le chiamate che utilizzano questo tipo avranno esito negativo con un errore di runtime se l'applicazione non dispone dell'autorizzazione di scrittura in "fileSystem".
"saveFile"
Richiede all'utente di aprire un file esistente o uno nuovo e restituisce una voce File scrivibile se l'operazione ha esito positivo. Le chiamate che utilizzano questo tipo avranno esito negativo con un errore di runtime se l'applicazione non dispone dell'autorizzazione di scrittura in "fileSystem".
"openDirectory"
Richiede all'utente di aprire una directory e restituisce una DirectoryEntry in caso di esito positivo. Le chiamate che utilizzano questo tipo avranno esito negativo con un errore di runtime se l'applicazione non dispone dell'autorizzazione "directory" in "fileSystem". Se l 'applicazione dispone dell'autorizzazione di scrittura in "fileSystem", la DirectoryEntry restituita sarà accessibile in scrittura, altrimenti sarà di sola lettura. Novità di Chrome 31.
RequestFileSystemOptions
Proprietà
-
volumeId
stringa
L'ID del volume richiesto.
-
scrivibile
booleano facoltativo
Indica se il file system richiesto deve essere scrivibile. L'impostazione predefinita è di sola lettura.
Volume
Proprietà
-
volumeId
stringa
-
scrivibile
boolean
VolumeListChangedEvent
Proprietà
-
volumi
Volume[]
Metodi
chooseEntry()
chrome.fileSystem.chooseEntry(
options?: ChooseEntryOptions,
callback: function,
)
Chiedi all'utente di scegliere un file o una directory.
Parametri
-
opzioni del modello.
ChooseEntryOptions facoltativo
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(entry?: Entry, fileEntries?: FileEntry[]) => void
-
voce
Voce facoltativa
-
fileEntries
FileEntry[] facoltativo
-
getDisplayPath()
chrome.fileSystem.getDisplayPath(
entry: Entry,
callback?: function,
)
Ottieni il percorso di visualizzazione di un oggetto Entry. Il percorso di visualizzazione si basa sul percorso completo del file o della directory nel file system locale, ma potrebbe essere reso più leggibile ai fini della visualizzazione.
Parametri
-
voce
Voce
-
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(displayPath: string) => void
-
displayPath
stringa
-
Ritorni
-
Promessa<string>
Chrome 117 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
getVolumeList()
chrome.fileSystem.getVolumeList(
callback?: function,
)
Restituisce un elenco dei volumi disponibili per requestFileSystem()
. L'autorizzazione per i file manifest "fileSystem": {"requestFileSystem"}
è obbligatoria. Disponibile solo per le app kiosk in esecuzione nella sessione kiosk. In caso di errore, volumes
non sarà definito e verrà impostato chrome.runtime.lastError
.
Parametri
Ritorni
-
Promessa<Volume[] | non definito>
Chrome 117 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
getWritableEntry()
chrome.fileSystem.getWritableEntry(
entry: Entry,
callback: function,
)
Ottieni una voce scrivibile da un'altra voce. Questa chiamata avrà esito negativo con un errore di runtime se l 'applicazione non dispone dell'autorizzazione di scrittura in "fileSystem". Se la voce è una DirectoryEntry, la chiamata avrà esito negativo se l'applicazione non dispone dell'autorizzazione "directory" in "fileSystem".
Parametri
-
voce
Voce
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(entry: Entry) => void
-
voce
Voce
-
isRestorable()
chrome.fileSystem.isRestorable(
id: string,
callback?: function,
)
Indica se l'app è autorizzata a ripristinare la voce con l'ID specificato.
Parametri
-
id
stringa
-
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(isRestorable: boolean) => void
-
isRestorable
boolean
-
Ritorni
-
Promise<boolean>
Chrome 117 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
isWritableEntry()
chrome.fileSystem.isWritableEntry(
entry: Entry,
callback?: function,
)
Riconosce se la voce è scrivibile o meno.
Parametri
-
voce
Voce
-
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(isWritable: boolean) => void
-
isWritable
boolean
-
Ritorni
-
Promise<boolean>
Chrome 117 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
requestFileSystem()
chrome.fileSystem.requestFileSystem(
options: RequestFileSystemOptions,
callback?: function,
)
Richiede l'accesso a un file system per un volume rappresentato da options.volumeId
. Se options.writable
è impostato su true, il file system sarà accessibile in scrittura. In caso contrario, sarà di sola lettura. L'opzione writable
richiede l'autorizzazione "fileSystem": {"write"}
nel file manifest. Disponibile solo per le app kiosk in esecuzione in sessione kiosk. Per l'avvio manuale della modalità kiosk, nella parte superiore della finestra dell'app attiva viene visualizzata una finestra di dialogo di conferma. In caso di errore, fileSystem
non sarà definito e verrà impostato chrome.runtime.lastError
.
Parametri
-
opzioni del modello.
-
callback
funzione facoltativa
Il parametro
callback
ha il seguente aspetto:(fileSystem?: FileSystem) => void
-
fileSystem
FileSystem facoltativo
-
Ritorni
-
Promise<FileSystem | undefined>
Chrome 117 e versioni successiveLe promesse sono supportate solo per Manifest V3 e versioni successive; altre piattaforme devono utilizzare i callback.
restoreEntry()
chrome.fileSystem.restoreEntry(
id: string,
callback: function,
)
Restituisce la voce del file con l'ID specificato, se può essere ripristinato. In caso contrario, questa chiamata avrà esito negativo con un errore di runtime.
Parametri
-
id
stringa
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(entry: Entry) => void
-
voce
Voce
-
retainEntry()
chrome.fileSystem.retainEntry(
entry: Entry,
)
Restituisce un ID che può essere passato a restoredEntry per riottenere l'accesso a una determinata voce di file. Vengono conservate solo le 500 voci utilizzate più di recente, in cui le chiamate a KeepEntry e restoredEntry vengono conteggiate come in uso. Se l'app ha l'autorizzazione "retainEntries" per "fileSystem", le voci vengono conservate per un tempo indeterminato. In caso contrario, le voci vengono conservate solo mentre l'app è in esecuzione e tra i riavvii.
Parametri
-
voce
Voce
Ritorni
-
stringa
Eventi
onVolumeListChanged
chrome.fileSystem.onVolumeListChanged.addListener(
callback: function,
)
Richiamato quando viene modificato un elenco di volumi disponibili.
Parametri
-
callback
funzione
Il parametro
callback
ha il seguente aspetto:(event: VolumeListChangedEvent) => void
-
event
-