chrome.fileSystemProvider

Description

Utilisez l'API chrome.fileSystemProvider pour créer des systèmes de fichiers accessibles à partir du gestionnaire de fichiers sur ChromeOS.

Autorisations

fileSystemProvider

Disponibilité

<ph type="x-smartling-placeholder"></ph> ChromeOS uniquement

Fichier manifeste

Vous devez déclarer la classe autorisation du fichier manifeste de l'extension et de la section correspondante pour utiliser l'API File System Provider. Exemple :

{
  "name": "My extension",
  ...
  "permissions": [
    "fileSystemProvider"
  ],
  ...
  "file_system_provider_capabilities": {
    "configurable": true,
    "watchable": false,
    "multiple_mounts": true,
    "source": "network"
  },
  ...
}

La section file_system_provider doit être déclarée comme suit:

configurable (booléen) : facultatif
Indique si la configuration via onConfigureRequested est acceptée. Valeur par défaut : "false".
multiple_mounts (booléen) : facultatif
Indique si plusieurs (plusieurs) systèmes de fichiers installés sont pris en charge. Valeur par défaut : "false".
watchable (booléen) : facultatif
Indique si la définition d'observateurs et l'envoi de notifications concernant les modifications sont prises en charge. Valeur par défaut : "false".
source (énumération de "file", "device" ou "network") - obligatoire
Source de données pour les systèmes de fichiers installés.

L'application Files utilise les informations ci-dessus pour afficher correctement les éléments d'interface utilisateur associés. Par exemple, si configurable est défini sur "true", un élément de menu permettant de configurer les volumes s'affiche. De même, si multiple_mounts est défini sur true, l'application Fichiers permet d'ajouter plusieurs points d'installation à partir de l'interface utilisateur. Si watchable est défini sur false, un bouton d'actualisation s'affiche. Notez que si possible, vous devez ajouter la prise en charge des observateurs, afin que les modifications apportées au système de fichiers soient répercutées immédiatement et automatiquement.

Présentation

L'API File System Provider permet aux extensions de prendre en charge les systèmes de fichiers virtuels, disponibles dans le gestionnaire de fichiers sur ChromeOS. Il peut s'agir par exemple de la décompression d'archives ou de l'accès à des fichiers dans un service cloud autre que Drive.

Installer des systèmes de fichiers

Les extensions peuvent fournir le contenu d'un système de fichiers à partir d'une source externe (telle qu'un serveur distant ou un périphérique USB) ou utiliser un fichier local (tel qu'une archive) comme entrée.

Pour écrire des systèmes de fichiers qui sont des gestionnaires de fichiers (la source est "file"), le fournisseur doit être une application empaquetée, car l'événement onLaunched n'est pas disponible pour les extensions.

Si la source est un réseau ou un appareil, le système de fichiers doit être installé lors de l'appel de l'événement onMountRequested.

Source des données du système de fichiers Point d'entrée
"file" Disponible uniquement pour les applications empaquetées.
"device" ou "network" onMountRequested

Configurer des systèmes de fichiers

Une fois installés, les systèmes de fichiers fournis peuvent être configurés via l'événement onConfigureRequested. Il est particulièrement utile pour les systèmes de fichiers qui fournissent du contenu via le réseau afin de définir les informations d’identification appropriées. La gestion de cet événement est facultative.

Cycle de vie

Une fois installés, les systèmes de fichiers fournis sont mémorisés par Chrome et réinstallés automatiquement après le redémarrage ou le redémarrage. Par conséquent, une fois qu'un système de fichiers est installé par une extension fournie, il reste jusqu'à ce que l'extension soit déchargée ou que l'extension appelle la méthode unmount.

Types

AbortRequestedOptions

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • operationRequestId

    Nombre

    Identifiant de la requête à annuler.

  • requestId

    Nombre

    Identifiant unique de cette requête.

Action

Chrome 45 ou version ultérieure

Propriétés

  • id

    chaîne

    Identifiant de l'action. Toute chaîne ou CommonActionId pour les actions courantes.

  • titre

    chaîne facultatif

    Titre de l'action. Elle peut être ignorée pour les actions courantes.

AddWatcherRequestedOptions

Propriétés

  • entryPath

    chaîne

    Chemin de l'entrée à observer.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • RECURSIVE

    booléen

    Indique si l'observation doit inclure toutes les entrées enfants de manière récursive. Cela ne peut être vrai que pour les répertoires.

  • requestId

    Nombre

    Identifiant unique de cette requête.

Change

Propriétés

  • changeType

    ChangeType

    Type de modification apportée à l'entrée.

  • cloudFileInfo

    CloudFileInfo facultatif

    Chrome 125 ou version ultérieure

    Informations concernant le fichier s'il repose sur un système de fichiers dans le cloud.

  • entryPath

    chaîne

    Chemin d'accès à l'entrée modifiée.

ChangeType

Type d'une modification détectée dans le répertoire observé.

Énumération

"MODIFIÉ"

"SUPPRIMÉ"

CloseFileRequestedOptions

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • openRequestId

    Nombre

    ID de requête utilisé pour ouvrir le fichier.

  • requestId

    Nombre

    Identifiant unique de cette requête.

CloudFileInfo

Chrome 125 ou version ultérieure

Propriétés

  • versionTag

    chaîne facultatif

    Tag qui représente la version du fichier.

CloudIdentifier

Chrome 117 ou version ultérieure

Propriétés

  • id

    chaîne

    Identifiant du fournisseur pour le fichier ou le répertoire donné.

  • providerName

    chaîne

    Identifiant du fournisseur de stockage cloud (par exemple, "drive.google.com").

CommonActionId

Chrome 45 ou version ultérieure

Liste des actions courantes. "SHARE" permet de partager des fichiers avec d'autres utilisateurs. "SAVE_FOR_OFFLINE" pour l'épinglage (enregistrement pour accès hors connexion). "OFFLINE_NOT_NECESSARY" pour avoir signalé que le fichier ne doit plus être stocké pour un accès hors connexion. Utilisé par onGetActionsRequested et onExecuteActionRequested.

Énumération

"SAVE_FOR_OFFLINE"

&quot;OFFLINE_NOT_NECESSARY&quot;

"PARTAGER"

ConfigureRequestedOptions

Chrome (version 44 ou ultérieure)

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers à configurer.

  • requestId

    Nombre

    Identifiant unique de cette requête.

CopyEntryRequestedOptions

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • requestId

    Nombre

    Identifiant unique de cette requête.

  • sourcePath

    chaîne

    Chemin d'accès source de l'entrée à copier.

  • targetPath

    chaîne

    Chemin de destination de l'opération de copie.

CreateDirectoryRequestedOptions

Propriétés

  • directoryPath

    chaîne

    Chemin d'accès au répertoire à créer.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • RECURSIVE

    booléen

    Indique si l'opération est récursive (pour les répertoires uniquement).

  • requestId

    Nombre

    Identifiant unique de cette requête.

CreateFileRequestedOptions

Propriétés

  • filePath

    chaîne

    Chemin d'accès au fichier à créer.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • requestId

    Nombre

    Identifiant unique de cette requête.

DeleteEntryRequestedOptions

Propriétés

  • entryPath

    chaîne

    Chemin de l'entrée à supprimer.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • RECURSIVE

    booléen

    Indique si l'opération est récursive (pour les répertoires uniquement).

  • requestId

    Nombre

    Identifiant unique de cette requête.

EntryMetadata

Propriétés

  • cloudFileInfo

    CloudFileInfo facultatif

    Chrome 125 ou version ultérieure

    Informations qui identifient un fichier spécifique dans le système de fichiers cloud sous-jacent. Doit être fourni si demandé dans options et que le fichier est sauvegardé dans Cloud Storage.

  • cloudIdentifier

    CloudIdentifier facultatif

    Chrome 117 ou version ultérieure

    Représentation Cloud Storage de cette entrée. Doit être fourni si demandé dans options et que le fichier est sauvegardé dans Cloud Storage. Pour les fichiers locaux qui ne sont pas sauvegardés dans Cloud Storage, cette option ne doit pas être définie à la demande.

  • isDirectory

    Booléen facultatif

    "True" s'il s'agit d'un répertoire. Doit être fourni si demandé dans options.

  • mimeType

    chaîne facultatif

    Type MIME pour l'entrée. Toujours facultatif, mais doit être fourni si demandé dans options.

  • modificationTime

    Date facultatif

    Heure de la dernière modification de cette entrée. Doit être fourni si demandé dans options.

  • nom

    chaîne facultatif

    Nom de cette entrée (pas le nom de chemin complet). Ne doit pas contenir "/". Pour la racine, elle doit être vide. Doit être fourni si demandé dans options.

  • taille

    numéro facultatif

    Taille du fichier en octets. Doit être fourni si demandé dans options.

  • thumbnail

    chaîne facultatif

    Vignette sous forme d'URI de données au format PNG, JPEG ou WEBP, d'une taille maximale de 32 Ko. Facultatif, mais ne peut être fourni que si l'événement onGetMetadataRequested l'a explicitement demandé.

ExecuteActionRequestedOptions

Chrome 45 ou version ultérieure

Propriétés

  • actionId

    chaîne

    Identifiant de l'action à exécuter.

  • entryPaths

    chaîne[]

    Chrome (version 47 ou ultérieure)

    Ensemble des chemins d'accès des entrées à utiliser pour l'action.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • requestId

    Nombre

    Identifiant unique de cette requête.

FileSystemInfo

Propriétés

  • displayName

    chaîne

    Nom lisible du système de fichiers.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers.

  • openedFiles

    OpenedFile[]

    Liste des fichiers actuellement ouverts.

  • openedFilesLimit

    Nombre

    Nombre maximal de fichiers pouvant être ouverts simultanément. Si 0, alors non limitée.

  • supportsNotifyTag

    Booléen facultatif

    Chrome 45 ou version ultérieure

    Indique si le système de fichiers prend en charge le champ tag pour l'observation des répertoires.

  • observateurs

    Observateur[]

    Chrome 45 ou version ultérieure

    Liste des observateurs.

  • accessible en écriture

    booléen

    Indique si le système de fichiers prend en charge des opérations susceptibles de modifier le contenu du système de fichiers (comme la création, la suppression ou l'écriture dans des fichiers).

GetActionsRequestedOptions

Chrome 45 ou version ultérieure

Propriétés

  • entryPaths

    chaîne[]

    Chrome (version 47 ou ultérieure)

    Liste des chemins d'accès des entrées pour la liste des actions.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • requestId

    Nombre

    Identifiant unique de cette requête.

GetMetadataRequestedOptions

Propriétés

  • cloudFileInfo

    booléen

    Chrome 125 ou version ultérieure

    Définissez ce paramètre sur true si la valeur cloudFileInfo est demandée.

  • cloudIdentifier

    booléen

    Chrome 117 ou version ultérieure

    Défini sur true si la valeur cloudIdentifier est demandée.

  • entryPath

    chaîne

    Chemin de l'entrée pour laquelle extraire les métadonnées.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • isDirectory

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur is_directory est demandée.

  • mimeType

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur mimeType est demandée.

  • modificationTime

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur modificationTime est demandée.

  • nom

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur name est demandée.

  • requestId

    Nombre

    Identifiant unique de cette requête.

  • taille

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur size est demandée.

  • thumbnail

    booléen

    Définissez ce paramètre sur true si la valeur thumbnail est demandée.

MountOptions

Propriétés

  • displayName

    chaîne

    Nom lisible du système de fichiers.

  • fileSystemId

    chaîne

    Identifiant de chaîne du système de fichiers. Doit être unique pour chaque extension.

  • openedFilesLimit

    numéro facultatif

    Nombre maximal de fichiers pouvant être ouverts simultanément. S'il n'est pas spécifié ou s'il est défini sur 0, cette action n'est pas limitée.

  • SSD

    Booléen facultatif

    Chrome (version 64 ou ultérieure)

    Indique si le framework doit réactiver le système de fichiers à la prochaine session de connexion. True par défaut.

  • supportsNotifyTag

    Booléen facultatif

    Chrome 45 ou version ultérieure

    Indique si le système de fichiers est compatible avec le champ tag pour les répertoires observés.

  • accessible en écriture

    Booléen facultatif

    Indique si le système de fichiers prend en charge des opérations susceptibles de modifier le contenu du système de fichiers (comme la création, la suppression ou l'écriture dans des fichiers).

MoveEntryRequestedOptions

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • requestId

    Nombre

    Identifiant unique de cette requête.

  • sourcePath

    chaîne

    Chemin source de l'entrée à déplacer vers un nouvel emplacement.

  • targetPath

    chaîne

    Chemin de destination de l'opération de copie.

NotifyOptions

Propriétés

  • changeType

    ChangeType

    Type de la modification apportée à l'entrée observée. Si elle est DELETED, l'entrée observée est automatiquement supprimée de la liste des entrées observées.

  • modifications

    Modification[] facultatif

    Liste des modifications apportées aux entrées du répertoire observé (y compris l'entrée elle-même)

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette modification.

  • observedPath

    chaîne

    Chemin de l'entrée observée.

  • RECURSIVE

    booléen

    Mode de l'entrée observée.

  • tag

    chaîne facultatif

    Tag de la notification. Obligatoire si le système de fichiers a été installé avec l'option supportsNotifyTag. Notez que cet indicateur est nécessaire pour fournir des notifications sur les modifications qui ont changé même lorsque le système a été arrêté.

OpenedFile

Propriétés

  • filePath

    chaîne

    Chemin d'accès au fichier ouvert.

  • Indique si le fichier a été ouvert en lecture ou en écriture.

  • openRequestId

    Nombre

    ID de requête à utiliser par les requêtes de lecture/écriture et de fermeture consécutives.

OpenFileMode

Mode d'ouverture d'un fichier. Utilisé par onOpenFileRequested.

Énumération

"LIRE"

"ÉCRIRE"

OpenFileRequestedOptions

Propriétés

  • filePath

    chaîne

    Chemin d'accès au fichier à ouvrir.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • Indique si le fichier sera utilisé pour la lecture ou l'écriture.

  • requestId

    Nombre

    ID de requête qui sera utilisé par les requêtes de lecture/écriture et de fermeture consécutives.

ProviderError

Codes d'erreur utilisés en fournissant des extensions en réponse aux requêtes, ainsi qu'en cas d'erreurs lors de l'appel des méthodes de l'API. Pour que l'opération réussisse, vous devez utiliser "OK".

Énumération

"OK"

"ÉCHEC"

"IN_USE"

"EXISTE"

"NOT_FOUND"

"ACCESS_DENIED"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NO_SPACE"

"NOT_A_DIRECTORY"

"INVALID_OPERATION" :

"SÉCURITÉ"

"ABORT"

"NOT_A_FILE"

"NOT_EMPTY"

"URL_NON_VALIDE"

"IO"

ReadDirectoryRequestedOptions

Propriétés

  • directoryPath

    chaîne

    Chemin d'accès au répertoire dans lequel les contenus sont demandés.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • isDirectory

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur is_directory est demandée.

  • mimeType

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur mimeType est demandée.

  • modificationTime

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur modificationTime est demandée.

  • nom

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur name est demandée.

  • requestId

    Nombre

    Identifiant unique de cette requête.

  • taille

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur size est demandée.

  • thumbnail

    booléen

    Chrome 49 ou version ultérieure

    Définissez ce paramètre sur true si la valeur thumbnail est demandée.

ReadFileRequestedOptions

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • longueur

    Nombre

    Nombre d'octets à renvoyer.

  • offset

    Nombre

    Position dans le fichier (en octets) à partir duquel commencer la lecture.

  • openRequestId

    Nombre

    ID de requête utilisé pour ouvrir le fichier.

  • requestId

    Nombre

    Identifiant unique de cette requête.

RemoveWatcherRequestedOptions

Propriétés

  • entryPath

    chaîne

    Chemin de l'entrée surveillée.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • RECURSIVE

    booléen

    Mode de l'observateur.

  • requestId

    Nombre

    Identifiant unique de cette requête.

TruncateRequestedOptions

Propriétés

  • filePath

    chaîne

    Chemin du fichier à tronquer.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • longueur

    Nombre

    Nombre d'octets à conserver une fois l'opération terminée.

  • requestId

    Nombre

    Identifiant unique de cette requête.

UnmountOptions

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers à désinstaller.

UnmountRequestedOptions

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers à désinstaller.

  • requestId

    Nombre

    Identifiant unique de cette requête.

Watcher

Propriétés

  • entryPath

    chaîne

    Chemin de l'entrée observée.

  • lastTag

    chaîne facultatif

    Tag utilisé par la dernière notification pour l'observateur.

  • RECURSIVE

    booléen

    Indique si la surveillance doit inclure toutes les entrées enfants de manière récursive. Cela ne peut être vrai que pour les répertoires.

WriteFileRequestedOptions

Propriétés

  • données

    ArrayBuffer

    Tampon d'octets à écrire dans le fichier.

  • fileSystemId

    chaîne

    Identifiant du système de fichiers associé à cette opération.

  • offset

    Nombre

    Position dans le fichier (en octets) à partir duquel commencer à écrire les octets.

  • openRequestId

    Nombre

    ID de requête utilisé pour ouvrir le fichier.

  • requestId

    Nombre

    Identifiant unique de cette requête.

Méthodes

get()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.fileSystemProvider.get(
  fileSystemId: string,
  callback?: function,
)

Renvoie des informations sur un système de fichiers avec le fileSystemId transmis.

Paramètres

  • fileSystemId

    chaîne

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    (fileSystem: FileSystemInfo) => void

Renvoie

  • Promise&lt;FileSystemInfo&gt;

    Chrome 96 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getAll()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.fileSystemProvider.getAll(
  callback?: function,
)

Renvoie tous les systèmes de fichiers installés par l'extension.

Paramètres

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    (fileSystems: FileSystemInfo[]) => void

Renvoie

  • Promise&lt;FileSystemInfo[]&gt;

    Chrome 96 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

mount()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.fileSystemProvider.mount(
  options: MountOptions,
  callback?: function,
)

Installe un système de fichiers avec les fileSystemId et displayName donnés. displayName s'affiche dans le panneau de gauche de l'application Fichiers. displayName peut contenir n'importe quel caractère, y compris "/", mais ne peut pas être une chaîne vide. displayName doit être descriptif, mais ne doit pas nécessairement être unique. L'fileSystemId ne doit pas être une chaîne vide.

Selon le type de système de fichiers installé, l'option source doit être définie de manière appropriée.

En cas d'erreur, runtime.lastError est défini avec un code d'erreur correspondant.

Paramètres

  • options

    MountOptions

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 96 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

notify()

<ph type="x-smartling-placeholder"></ph> Promesse Chrome (version 45 ou ultérieure) 
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
  callback?: function,
)

Notifie les modifications apportées au répertoire surveillé à l'adresse observedPath en mode recursive. Si le système de fichiers est installé avec supportsNotifyTag, alors tag doit être fourni. Toutes les modifications apportées depuis la dernière notification sont toujours signalées, même si le système a été arrêté. La dernière balise peut être obtenue avec getAll.

Pour que vous puissiez l'utiliser, l'option de fichier manifeste file_system_provider.notify doit être définie sur "true".

La valeur de tag peut être n'importe quelle chaîne unique pour chaque appel, afin qu'il soit possible d'identifier la dernière notification enregistrée. Par exemple, Si l'extension fournie commence après un redémarrage et que la balise de la dernière notification enregistrée est égale à "123", elle doit appeler notify pour toutes les modifications survenues depuis la modification marquée comme "123". Cette chaîne ne peut pas être vide.

Tous les fournisseurs ne sont pas en mesure de fournir un tag, mais si le système de fichiers dispose d'un journal de modifications, ce tag peut être, par exemple, un numéro de modification ou un numéro de révision.

Notez que si un répertoire parent est supprimé, toutes les entrées descendantes sont également supprimées. Si elles sont surveillées, l'API doit en être informée. De plus, si un répertoire est renommé, toutes les entrées descendantes sont effectivement supprimées, car il n'existe plus d'entrée sous leurs chemins d'accès d'origine.

En cas d'erreur, runtime.lastError est défini et génère un code d'erreur correspondant.

Paramètres

  • options

    NotifyOptions

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 96 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

unmount()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
  callback?: function,
)

Désinstalle un système de fichiers avec l'fileSystemId donné. Elle doit être appelée après l'appel de onUnmountRequested. En outre, l'extension peut décider de la désinstaller si elle n'est pas demandée (par exemple, en cas de perte de connexion ou d'erreur de fichier).

En cas d'erreur, runtime.lastError est défini avec un code d'erreur correspondant.

Paramètres

  • options

    UnmountOptions

  • rappel

    function facultatif

    Le paramètre callback se présente comme suit: 

    () => void

Renvoie

  • Promesse<void>

    Chrome 96 ou version ultérieure

    Les promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onAbortRequested

chrome.fileSystemProvider.onAbortRequested.addListener(
  callback: function,
)

Générée lors de l'annulation d'une opération avec operationRequestId. L'opération exécutée avec operationRequestId doit être immédiatement arrêtée et successCallback de cette requête d'abandon doit être exécutée. Si l'annulation échoue, errorCallback doit être appelé. Notez que les rappels de l'opération annulée ne doivent pas être appelés, car ils seront ignorés. Malgré l'appel de errorCallback, la requête peut être abandonnée de force.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: AbortRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onAddWatcherRequested

Chrome 45 ou version ultérieure 
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Générée lors de la définition d'un nouvel observateur de répertoire. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: AddWatcherRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onCloseFileRequested

chrome.fileSystemProvider.onCloseFileRequested.addListener(
  callback: function,
)

Générée lors de l'ouverture d'un fichier précédemment ouvert avec openRequestId est demandée pour être fermée.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: CloseFileRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onConfigureRequested

Chrome (version 44 ou ultérieure) 
chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

Générée lors de l'affichage d'une boîte de dialogue de configuration pour fileSystemId. Si c'est le cas, l'option file_system_provider.configurable doit être définie sur "true".

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: ConfigureRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onCopyEntryRequested

chrome.fileSystemProvider.onCopyEntryRequested.addListener(
  callback: function,
)

Générée lors de la copie d'une entrée (de manière récursive si un répertoire) est demandée. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: CopyEntryRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onCreateDirectoryRequested

chrome.fileSystemProvider.onCreateDirectoryRequested.addListener(
  callback: function,
)

Générée lors de la création d'un répertoire est demandée. L'opération doit échouer et renvoyer l'erreur EXISTS si le répertoire cible existe déjà. Si recursive est défini sur "true", tous les répertoires manquants dans le chemin du répertoire doivent être créés.

Paramètres

onCreateFileRequested

chrome.fileSystemProvider.onCreateFileRequested.addListener(
  callback: function,
)

Générée lors de la création d'un fichier est demandée. Si le fichier existe déjà, errorCallback doit être appelé avec le code d'erreur "EXISTS".

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: CreateFileRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onDeleteEntryRequested

chrome.fileSystemProvider.onDeleteEntryRequested.addListener(
  callback: function,
)

Générée lors de la demande de suppression d'une entrée. Si recursive a la valeur "true" et que l'entrée est un répertoire, toutes les entrées qu'il contient doivent également être supprimées de manière récursive.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: DeleteEntryRequestedOptions, successCallback: function, errorCallback: function) => void

onExecuteActionRequested

Chrome (version 48 ou ultérieure) 
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Générée lors de l'exécution d'une action sur un ensemble de fichiers ou de répertoires est demandée. Une fois l'action terminée, successCallback doit être appelé. En cas d'erreur, errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: ExecuteActionRequestedOptions, successCallback: function, errorCallback: function) => void

onGetActionsRequested

Chrome (version 48 ou ultérieure) 
chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

Déclenché lorsqu'une liste d'actions est demandée pour un ensemble de fichiers ou de répertoires sur entryPaths. Toutes les actions renvoyées doivent être applicables à chaque entrée. En l'absence de telles actions, un tableau vide doit être renvoyé. Les actions doivent être renvoyées avec l'appel successCallback. En cas d'erreur, errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: GetActionsRequestedOptions, successCallback: function, errorCallback: function) => void

onGetMetadataRequested

chrome.fileSystemProvider.onGetMetadataRequested.addListener(
  callback: function,
)

Générée lorsque les métadonnées d'un fichier ou d'un répertoire de entryPath sont demandées. Les métadonnées doivent être renvoyées avec l'appel successCallback. En cas d'erreur, errorCallback doit être appelé.

Paramètres

onMountRequested

Chrome (version 44 ou ultérieure) 
chrome.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

Générée lors de l'affichage d'une boîte de dialogue pour l'installation d'un nouveau système de fichiers est demandée. Si l'extension ou l'application est un gestionnaire de fichiers, cet événement ne doit pas être géré. À la place, app.runtime.onLaunched doit être géré afin d'installer de nouveaux systèmes de fichiers lorsqu'un fichier est ouvert. En cas d'installations multiples, l'option de fichier manifeste file_system_provider.multiple_mounts doit être définie sur "true".

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onMoveEntryRequested

chrome.fileSystemProvider.onMoveEntryRequested.addListener(
  callback: function,
)

Générée lors du déplacement d'une entrée (de manière récursive si un répertoire) est demandée. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: MoveEntryRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onOpenFileRequested

chrome.fileSystemProvider.onOpenFileRequested.addListener(
  callback: function,
)

Générée lors de l'ouverture d'un fichier à l'adresse filePath. Si le fichier n'existe pas, l'opération doit échouer. Vous pouvez spécifier le nombre maximal de fichiers ouverts simultanément avec MountOptions.

Paramètres

onReadDirectoryRequested

chrome.fileSystemProvider.onReadDirectoryRequested.addListener(
  callback: function,
)

Générée lorsque le contenu d'un répertoire situé à l'emplacement directoryPath est demandé. Les résultats doivent être renvoyés par fragments en appelant successCallback plusieurs fois. En cas d'erreur, errorCallback doit être appelé.

Paramètres

onReadFileRequested

chrome.fileSystemProvider.onReadFileRequested.addListener(
  callback: function,
)

Générée lors de la lecture du contenu d'un fichier ouvert précédemment avec openRequestId. Les résultats doivent être renvoyés par fragments en appelant successCallback plusieurs fois. En cas d'erreur, errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: ReadFileRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      (data: ArrayBuffer, hasMore: boolean) => void

      • données

        ArrayBuffer

      • hasMore

        booléen

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onRemoveWatcherRequested

Chrome 45 ou version ultérieure 
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

Déclenché lorsque l'observateur doit être supprimé. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: RemoveWatcherRequestedOptions, successCallback: function, errorCallback: function) => void

onTruncateRequested

chrome.fileSystemProvider.onTruncateRequested.addListener(
  callback: function,
)

Générée lors de la troncation d'un fichier jusqu'à la longueur souhaitée. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: TruncateRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onUnmountRequested

chrome.fileSystemProvider.onUnmountRequested.addListener(
  callback: function,
)

Générée lors du démontage du système de fichiers avec l'identifiant fileSystemId. Dans la réponse, la méthode API unmount doit être appelée avec successCallback. Si le démontage n'est pas possible (en raison d'une opération en attente, par exemple), errorCallback doit être appelé.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: UnmountRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void

onWriteFileRequested

chrome.fileSystemProvider.onWriteFileRequested.addListener(
  callback: function,
)

Générée lors de l'écriture de contenu dans un fichier ouvert précédemment avec openRequestId.

Paramètres

  • rappel

    fonction

    Le paramètre callback se présente comme suit: 

    (options: WriteFileRequestedOptions, successCallback: function, errorCallback: function) => void

    • successCallback

      fonction

      Le paramètre successCallback se présente comme suit: 

      () => void

    • errorCallback

      fonction

      Le paramètre errorCallback se présente comme suit: 

      (error: ProviderError) => void