chrome.fileSystem

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 avvisati tramite chrome.runtime.lastError.

Autorizzazioni

fileSystem

Disponibilità

Solo in primo piano .

Tipi

AcceptOption

Proprietà

  • descrizione

    stringa facoltativo

    Descrizione di testo facoltativa per questa opzione. Se non è presente, verrà generata automaticamente una descrizione. generalmente contiene un elenco espanso 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 "immagine/jpeg" o "audio/*". Uno dei tipi MIME o delle estensioni deve contenere almeno un elemento valido.

ChooseEntryOptions

Proprietà

  • accetta

    AcceptOption[] facoltativo

    L'elenco facoltativo delle opzioni di accettazione per questo apri file. Ogni opzione verrà presentata all'utente finale come un gruppo univoco.

  • acceptsAllTypes

    booleano facoltativo

    Indica se accettare tutti i tipi di file, oltre alle opzioni specificate nell'argomento accetta. Il valore predefinito è true. Se il campo accetta non è impostato o non contiene voci valide, il valore verrà sempre reimpostato su true.

  • acceptsMultiple

    booleano facoltativo

    Indica se accettare più file. Questo attributo è supportato 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à chiamato con una singola voce.

  • suggestedName

    stringa facoltativo

    Il nome file suggerito che verrà presentato all'utente come nome predefinito da leggere o scrivere. Questa opzione è facoltativa.

  • tipo

    ChooseEntryType Facoltativo

    Tipo di prompt da mostrare. Il valore predefinito è "openFile".

ChooseEntryType

Enum

"openFile"
Chiedi all'utente di aprire un file esistente e, se l'operazione riesce, restituisce una voce FileEntry. A partire da Chrome 31, sarà possibile scrivere su FileEntry se l'applicazione dispone della funzionalità "write" autorizzazione in "fileSystem"; altrimenti FileEntry sarà di sola lettura.

"openWritableFile"
Chiedi all'utente di aprire un file esistente e, se l'operazione riesce, restituisce una voce FileEntry scrivibile. Le chiamate che utilizzano questo tipo non andranno a buon fine con un errore di runtime se l'applicazione non dispone della funzionalità in "fileSystem".

"saveFile"
Chiedi all'utente di aprire un file esistente o un nuovo file e, se l'operazione riesce, restituisce una voce FileEntry scrivibile. Le chiamate che utilizzano questo tipo non andranno a buon fine con un errore di runtime se l'applicazione non dispone della funzionalità in "fileSystem".

"openDirectory"
Chiedi all'utente di aprire una directory e restituisce una DirectoryEntry se l'operazione è andata a buon fine. Le chiamate che utilizzano questo tipo non andranno a buon fine e verrà generato un errore di runtime se l'applicazione non dispone della "directory" in "fileSystem". Se l'applicazione ha lo spazio di archiviazione l'autorizzazione in "fileSystem", la DirectoryEntry restituita sarà scrivibile; altrimenti sarà di sola lettura. Novità di Chrome 31.

RequestFileSystemOptions

Chrome 44 e versioni successive .

Proprietà

  • volumeId

    stringa

    L'ID del volume richiesto.

  • accessibile in scrittura

    booleano facoltativo

    Indica se il file system richiesto deve essere scrivibile. L'impostazione predefinita è di sola lettura.

Volume

Chrome 44 e versioni successive .

Proprietà

  • volumeId

    stringa

  • accessibile in scrittura

    booleano

VolumeListChangedEvent

Chrome 44 e versioni successive .

Proprietà

Metodi

chooseEntry()

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

Chiedi all'utente di scegliere un file o una directory.

Parametri

  • opzioni

    ChooseEntryOptions (Facoltativo)

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

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

    • voce

      Voce facoltativa

    • fileEntries

      FileEntry[] facoltativo

getDisplayPath()

Promesso .
chrome.fileSystem.getDisplayPath(
  entry: Entry,
  callback?: function,
)

Recupera 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

Resi

  • Promise<string>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getVolumeList()

Promesso Chrome 44 e versioni successive 
chrome.fileSystem.getVolumeList(
  callback?: function,
)

Restituisce un elenco di volumi disponibili per requestFileSystem(). È richiesta l'autorizzazione per il file manifest "fileSystem": {"requestFileSystem"}. 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

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (volumes?: Volume[]) => void

    • volumi

      Volume[] facoltativo

Resi

  • Promise<Volume[] | non definito>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getWritableEntry()

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

Ottieni una voce in scrittura da un'altra voce. Questa chiamata avrà esito negativo e restituisce un errore di runtime se l'applicazione non dispone della funzionalità in "fileSystem". Se la voce è una DirectoryEntry, questa chiamata non riuscirà se l'applicazione non dispone della "directory" in "fileSystem".

Parametri

  • voce

    Voce

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (entry: Entry) => void

    • voce

      Voce

isRestorable()

Promesso .
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

      booleano

Resi

  • Promise<boolean>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

isWritableEntry()

Promesso .
chrome.fileSystem.isWritableEntry(
  entry: Entry,
  callback?: function,
)

Indica se la voce è scrivibile o meno.

Parametri

  • voce

    Voce

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (isWritable: boolean) => void

    • isWritable

      booleano

Resi

  • Promise<boolean>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

requestFileSystem()

Promesso Chrome 44 e versioni successive 
chrome.fileSystem.requestFileSystem(
  options: RequestFileSystemOptions,
  callback?: function,
)

Richiedi l'accesso a un file system per un volume rappresentato da options.volumeId. Se options.writable viene 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 nella sessione kiosk. Per la modalità kiosk con avvio manuale, viene mostrata una finestra di dialogo di conferma nella parte superiore della finestra dell'app attiva. In caso di errore, fileSystem non sarà definito e verrà impostato chrome.runtime.lastError.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (fileSystem?: FileSystem) => void

    • fileSystem

      FileSystem facoltativo

Resi

  • Promise<FileSystem | non definito>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le 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 non andrà a buon fine e verrà generato 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 restoreEntry per recuperare l'accesso a una determinata voce del file. Vengono conservate solo le 500 voci utilizzate più di recente, mentre le chiamate per keepEntry e restoreEntry vengono conteggiate come utilizzo. Se l'app include "retainEntries" autorizzazione in "fileSystem", le voci vengono conservate per un periodo indeterminato. In caso contrario, le voci vengono conservate solo mentre l'app è in esecuzione e dopo i riavvii.

Parametri

  • voce

    Voce

Resi

  • stringa

Eventi

onVolumeListChanged

Chrome 44 e versioni successive .
chrome.fileSystem.onVolumeListChanged.addListener(
  callback: function,
)

Richiamato se viene modificato un elenco di volumi disponibili.

Parametri