browser.fileSystemProvider

Description

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

Autorisations

fileSystemProvider

Disponibilité

ChromeOS uniquement

Vous devez déclarer l'autorisation et la section "fileSystemProvider" dans le fichier manifeste de l'extension 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 possible. Par défaut : false.
multiple_mounts (booléen) – Facultatif
Indique si plusieurs systèmes de fichiers installés sont acceptés. Par défaut : false.
watchable (booléen) – Facultatif
Indique si la définition d'observateurs et la notification des modifications sont acceptées. 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 Fichiers 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 permettra 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 compatibilité avec les observateurs, afin que les modifications apportées au système de fichiers puissent être reflété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, qui sont disponibles dans le gestionnaire de fichiers sur ChromeOS. Les cas d'utilisation incluent la décompression d'archives et l'accès à des fichiers dans un service cloud autre que Drive.

Installer des systèmes de fichiers

Les extensions de fournisseur peuvent fournir le contenu d'un système de fichiers à partir d'une source externe (comme un serveur distant ou un appareil USB) ou utiliser un fichier local (comme 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é lorsque l'événement onMountRequested est appelé.

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 identifiants appropriés. 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 un redémarrage. Par conséquent, une fois qu'un système de fichiers est installé par une extension, il reste en place jusqu'à ce que l'extension soit déchargée ou qu'elle 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

    ID de la requête à annuler.

  • requestId

    nombre

    Identifiant unique de cette requête.

Action

Chrome 45 ou version ultérieure browser.* depuis Chrome 148

Propriétés

  • id

    chaîne

    Identifiant de l'action. N'importe quelle chaîne ou CommonActionId pour les actions courantes.

  • titre

    chaîne facultatif

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

AddWatcherRequestedOptions

Propriétés

  • entryPath

    chaîne

    Chemin d'accès 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. La valeur de champ "true" n'est applicable qu'aux 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+ browser.* depuis Chrome 148

    Informations relatives au fichier s'il est sauvegardé par un système de fichiers cloud.

  • entryPath

    chaîne

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

ChangeType

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

Énumération

"CHANGED"

"DELETED"

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+ browser.* depuis Chrome 148

Propriétés

  • versionTag

    chaîne facultatif

    Tag représentant la version du fichier.

CloudIdentifier

Chrome 117+ browser.* depuis Chrome 148

Propriétés

  • id

    chaîne

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

  • providerName

    chaîne

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

CommonActionId

Chrome 45 ou version ultérieure browser.* depuis Chrome 148

Liste des actions courantes. "SHARE" permet de partager des fichiers avec d'autres personnes. "SAVE_FOR_OFFLINE" pour épingler (enregistrer pour un accès hors connexion). "OFFLINE_NOT_NECESSARY" pour indiquer que le fichier n'a plus besoin d'être stocké pour un accès hors connexion. Utilisé par onGetActionsRequested et onExecuteActionRequested.

Énumération

"SAVE_FOR_OFFLINE"

"OFFLINE_NOT_NECESSARY"

"PARTAGER"

ConfigureRequestedOptions

Chrome 44+ browser.* depuis Chrome 148

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 d'accès à 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+ browser.* depuis Chrome 148

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

  • cloudIdentifier

    CloudIdentifier facultatif

    Chrome 117+ browser.* depuis Chrome 148

    Représentation Cloud Storage de cette entrée. Doit être fourni si demandé dans options et si le fichier est sauvegardé dans Cloud Storage. Pour les fichiers locaux qui ne sont pas sauvegardés dans le stockage cloud, il doit être non défini lorsqu'il est demandé.

  • isDirectory

    boolean facultatif

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

  • mimeType

    chaîne facultatif

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

  • modificationTime

    Date facultative

    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 du chemin d'accès complet). Ne doit pas contenir de "/". Pour la racine, il doit être vide. Doit être fourni si demandé dans options.

  • taille

    number facultatif

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

  • vignette

    chaîne facultatif

    Image miniature 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 le demande explicitement.

ExecuteActionRequestedOptions

Chrome 45 ou version ultérieure browser.* depuis Chrome 148

Propriétés

  • actionId

    chaîne

    Identifiant de l'action à exécuter.

  • entryPaths

    chaîne[]

    Chrome 47 et versions ultérieures browser.* depuis Chrome 148

    Ensemble de 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 par l'humain 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 la valeur est 0, aucune limite n'est appliquée.

  • supportsNotifyTag

    boolean facultatif

    Chrome 45 ou version ultérieure browser.* depuis Chrome 148

    Indique si le système de fichiers est compatible avec le champ tag pour l'observation des répertoires.

  • observateurs

    Watcher[]

    Chrome 45 ou version ultérieure browser.* depuis Chrome 148

    Liste des observateurs.

  • accessible en écriture

    booléen

    Indique si le système de fichiers accepte les opérations susceptibles de modifier son contenu (comme la création, la suppression ou l'écriture de fichiers).

GetActionsRequestedOptions

Chrome 45 ou version ultérieure browser.* depuis Chrome 148

Propriétés

  • entryPaths

    chaîne[]

    Chrome 47 et versions ultérieures browser.* depuis Chrome 148

    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+ browser.* depuis Chrome 148

    Définissez cette option sur true si la valeur cloudFileInfo est demandée.

  • cloudIdentifier

    booléen

    Chrome 117+ browser.* depuis Chrome 148

    Définissez cette option sur true si la valeur cloudIdentifier est demandée.

  • entryPath

    chaîne

    Chemin d'accès de l'entrée pour laquelle récupérer les métadonnées.

  • fileSystemId

    chaîne

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

  • isDirectory

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur is_directory est demandée.

  • mimeType

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur mimeType est demandée.

  • modificationTime

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur modificationTime est demandée.

  • nom

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur name est demandée.

  • requestId

    nombre

    Identifiant unique de cette requête.

  • taille

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur size est demandée.

  • vignette

    booléen

    Définissez cette option sur true si la valeur thumbnail est demandée.

MountOptions

Propriétés

  • displayName

    chaîne

    Nom lisible par l'humain du système de fichiers.

  • fileSystemId

    chaîne

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

  • openedFilesLimit

    number facultatif

    Nombre maximal de fichiers pouvant être ouverts simultanément. Si ce champ n'est pas spécifié ou s'il est défini sur 0, aucune limite n'est appliquée.

  • persistant

    boolean facultatif

    Chrome 64+ browser.* depuis Chrome 148

    Indique si le framework doit reprendre le système de fichiers lors de la prochaine session de connexion. "True" par défaut.

  • supportsNotifyTag

    boolean facultatif

    Chrome 45 ou version ultérieure browser.* depuis Chrome 148

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

  • accessible en écriture

    boolean facultatif

    Indique si le système de fichiers accepte les opérations susceptibles de modifier son contenu (comme la création, la suppression ou l'écriture de 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 d'accès 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 modification apportée à l'entrée observée. Si elle est SUPPRIMÉE, l'entrée observée sera automatiquement supprimée de la liste des entrées observées.

  • modifications

    Change[] 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 d'accès 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 été apportées même lorsque le système était 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

"READ"

"WRITE"

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 par les extensions de fournisseur en réponse aux requêtes, ainsi qu'en cas d'erreur lors de l'appel de méthodes de l'API. Pour réussir, vous devez utiliser "OK".

Énumération

"OK"

"FAILED"

"IN_USE"

"EXISTS"

"NOT_FOUND"

"ACCESS_DENIED"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NO_SPACE"

"NOT_A_DIRECTORY"

"INVALID_OPERATION"

"SECURITY"

"ABORT"

"NOT_A_FILE"

"NOT_EMPTY"

"INVALID_URL"

"IO"

ReadDirectoryRequestedOptions

Propriétés

  • directoryPath

    chaîne

    Chemin d'accès au répertoire dont le contenu est demandé.

  • fileSystemId

    chaîne

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

  • isDirectory

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur is_directory est demandée.

  • mimeType

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur mimeType est demandée.

  • modificationTime

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur modificationTime est demandée.

  • nom

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur name est demandée.

  • requestId

    nombre

    Identifiant unique de cette requête.

  • taille

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option sur true si la valeur size est demandée.

  • vignette

    booléen

    Navigateur Chrome 49 ou version ultérieure * depuis Chrome 148

    Définissez cette option 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 de laquelle la lecture doit commencer.

  • 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 d'accès 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 d'accès au 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émonter.

UnmountRequestedOptions

Propriétés

  • fileSystemId

    chaîne

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

  • requestId

    nombre

    Identifiant unique de cette requête.

Watcher

Propriétés

  • entryPath

    chaîne

    Chemin d'accès de l'entrée observée.

  • lastTag

    chaîne facultatif

    Balise utilisée 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. La valeur de champ "true" n'est applicable qu'aux 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 de laquelle 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()

browser.fileSystemProvider.get(
  fileSystemId: string,
): Promise<FileSystemInfo>

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

Paramètres

  • fileSystemId

    chaîne

Renvoie

  • Promise<FileSystemInfo>

    Chrome 96+ browser.* depuis Chrome 148

    Rappel pour recevoir le résultat de la fonction get.

getAll()

browser.fileSystemProvider.getAll(): Promise<FileSystemInfo[]>

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

Renvoie

  • Promise<FileSystemInfo[]>

    Chrome 96+ browser.* depuis Chrome 148

    Rappel pour recevoir le résultat de la fonction getAll.

mount()

browser.fileSystemProvider.mount(
  options: MountOptions,
): Promise<void>

Installe un système de fichiers avec les fileSystemId et displayName indiqués. displayName s'affichera 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 n'a pas besoin d'être unique. 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 sera défini avec un code d'erreur correspondant.

Paramètres

Renvoie

  • Promise<void>

    Chrome 96+ browser.* depuis Chrome 148

    Rappel de résultat générique pour indiquer la réussite ou l'échec.

notify()

Chrome 45 ou version ultérieure browser.* depuis Chrome 148 
browser.fileSystemProvider.notify(
  options: NotifyOptions,
): Promise<void>

Notifie les modifications apportées au répertoire surveillé à l'emplacement observedPath en mode recursive. Si le système de fichiers est installé avec supportsNotifyTag, tag doit être fourni, et toutes les modifications apportées depuis la dernière notification doivent toujours être signalées, même si le système a été arrêté. Le dernier tag peut être obtenu avec getAll.

Pour 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 par appel, ce qui permet d'identifier la dernière notification enregistrée. Par exemple, si l'extension de fournisseur démarre après un redémarrage et que le tag de la dernière notification enregistrée est égal à "123", elle doit appeler notify pour toutes les modifications qui ont eu lieu depuis la modification taguée "123". Il ne peut pas s'agir d'une chaîne vide.

Tous les fournisseurs ne sont pas en mesure de fournir un tag, mais si le système de fichiers dispose d'un journal des modifications, le 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 en fait supprimées, car il n'y a plus d'entrée sous leur chemin d'accès d'origine.

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

Paramètres

Renvoie

  • Promise<void>

    Chrome 96+ browser.* depuis Chrome 148

    Rappel de résultat générique pour indiquer la réussite ou l'échec.

unmount()

browser.fileSystemProvider.unmount(
  options: UnmountOptions,
): Promise<void>

Désinstalle un système de fichiers avec l'fileSystemId donné. Il doit être appelé après l'appel de onUnmountRequested. De plus, l'extension fournissant le système de fichiers peut décider de le démonter même si cela n'est pas demandé (par exemple, en cas de perte de connexion ou d'erreur de fichier).

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

Paramètres

Renvoie

  • Promise<void>

    Chrome 96+ browser.* depuis Chrome 148

    Rappel de résultat générique pour indiquer la réussite ou l'échec.

Événements

onAbortRequested

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

Déclenché lorsque l'abandon d'une opération avec operationRequestId est demandé. 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é. Si l'abandon échoue, errorCallback doit être appelé. Notez que les rappels de l'opération abandonnée ne doivent pas être appelés, car ils seront ignorés. Même si vous appelez errorCallback, la requête peut être interrompue de force.

Paramètres

  • callback

    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 browser.* depuis Chrome 148 
browser.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Déclenché lorsqu'un nouveau watcher de répertoire est demandé. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • callback

    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

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

Déclenché lorsqu'un fichier précédemment ouvert avec openRequestId doit être fermé.

Paramètres

  • callback

    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 44+ browser.* depuis Chrome 148 
browser.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

Déclenché lorsqu'une boîte de dialogue de configuration pour fileSystemId est demandée. Si elle est gérée, l'option de fichier manifeste file_system_provider.configurable doit être définie sur "true".

Paramètres

  • callback

    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

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

Déclenché lorsqu'une demande de copie d'une entrée (de manière récursive s'il s'agit d'un répertoire) est effectuée. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • callback

    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

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

Déclenché lorsqu'une demande de création de répertoire est effectuée. L'opération doit échouer avec 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 d'accès au répertoire doivent être créés.

Paramètres

  • callback

    fonction

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

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

onCreateFileRequested

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

Déclenché lorsqu'une demande de création de fichier est effectuée. Si le fichier existe déjà, errorCallback doit être appelé avec le code d'erreur "EXISTS".

Paramètres

  • callback

    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

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

Déclenché lorsqu'une demande de suppression d'une entrée est effectuée. Si recursive est défini sur "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

  • callback

    fonction

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

    (options: DeleteEntryRequestedOptions, 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

onExecuteActionRequested

Chrome 48+ browser.* depuis Chrome 148 
browser.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Déclenché lorsqu'une action est demandée pour un ensemble de fichiers ou de répertoires. Une fois l'action terminée, successCallback doit être appelé. En cas d'erreur, errorCallback doit être appelé.

Paramètres

  • callback

    fonction

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

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

onGetActionsRequested

Chrome 48+ browser.* depuis Chrome 148 
browser.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

Déclenché lorsqu'une liste d'actions pour un ensemble de fichiers ou de répertoires est demandée au niveau de entryPaths. Toutes les actions renvoyées doivent être applicables à chaque entrée. Si aucune action de ce type n'est disponible, 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

  • callback

    fonction

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

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

onGetMetadataRequested

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

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

Paramètres

onMountRequested

Chrome 44+ browser.* depuis Chrome 148 
browser.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

Déclenché lorsqu'une boîte de dialogue permettant d'installer un nouveau système de fichiers est demandée. Si l'extension/application est un gestionnaire de fichiers, cet événement ne doit pas être géré. À la place, app.runtime.onLaunched doit être géré pour installer de nouveaux systèmes de fichiers lorsqu'un fichier est ouvert. Pour les installations multiples, l'option de fichier manifeste file_system_provider.multiple_mounts doit être définie sur "true".

Paramètres

  • callback

    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

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

Déclenché lorsqu'un déplacement d'entrée (récursif s'il s'agit d'un répertoire) est demandé. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • callback

    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

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

Déclenché lorsqu'une demande d'ouverture d'un fichier à l'emplacement filePath est effectuée. Si le fichier n'existe pas, l'opération doit échouer. Le nombre maximal de fichiers ouverts simultanément peut être spécifié avec MountOptions.

Paramètres

onReadDirectoryRequested

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

Déclenché 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

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

Déclenché 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

  • callback

    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 browser.* depuis Chrome 148 
browser.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

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

Paramètres

  • callback

    fonction

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

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

onTruncateRequested

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

Déclenché lorsqu'une troncation d'un fichier à une longueur souhaitée est demandée. Si une erreur se produit, errorCallback doit être appelé.

Paramètres

  • callback

    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

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

Déclenché lorsqu'un démontage du système de fichiers avec l'identifiant fileSystemId est demandé. Dans la réponse, la méthode API unmount doit être appelée avec successCallback. S'il n'est pas possible de démonter (par exemple, en raison d'une opération en attente), errorCallback doit être appelé.

Paramètres

  • callback

    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

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

Déclenché lorsque l'écriture de contenus dans un fichier précédemment ouvert avec openRequestId est demandée.

Paramètres

  • callback

    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