chrome.fileSystemProvider

Description

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

Autorisations

fileSystemProvider

Disponibilité

ChromeOS uniquement

Vous devez déclarer l'autorisation et la section "fileSystemProvider" dans le 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 acceptée. Par défaut, la valeur est "false".
multiple_mounts (booléen) : facultatif
Indique si plusieurs systèmes de fichiers montés sont acceptés. Par défaut, la valeur est "false".
watchable (booléen) : facultatif
Indique si la définition de responsables et l'envoi de notifications concernant les modifications sont acceptés. Par défaut, la valeur est "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 sera affiché. De même, si multiple_mounts est défini sur true, l'application Fichiers permet d'ajouter plusieurs points de montage à partir de l'UI. 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 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 peuvent fournir le contenu du système de fichiers à partir d'une source externe (telle qu'un serveur distant ou un périphérique USB) ou en utilisant 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 packagé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 monté 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 packagées.
"device" ou "network" onMountRequested

Configurer les systèmes de fichiers

Une fois monté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 montés, les systèmes de fichiers fournis sont mémorisés par Chrome et remontés automatiquement après un redémarrage. Par conséquent, une fois qu'un système de fichiers est monté par une extension de fournisseur, 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

    Total

    ID de la requête à abandonner.

  • requestId

    Total

    Identifiant unique de cette requête.

Action

Chrome 45 et versions ultérieures

Propriétés

  • id

    chaîne

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

  • titre

    chaîne facultative

    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 "true" ne peut être définie que pour les répertoires.

  • requestId

    Total

    Identifiant unique de cette requête.

Change

Propriétés

  • changeType

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

  • cloudFileInfo

    CloudFileInfo facultatif

    Chrome 125 et versions ultérieures

    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

    Total

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

  • requestId

    Total

    Identifiant unique de cette requête.

CloudFileInfo

Chrome 125 et versions ultérieures

Propriétés

  • versionTag

    chaîne facultative

    Tag représentant la version du fichier.

CloudIdentifier

Chrome 117 et versions ultérieures

Propriétés

  • id

    chaîne

    Identifiant du fournisseur pour le fichier ou le répertoire en question.

  • providerName

    chaîne

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

CommonActionId

Chrome 45 et versions ultérieures

Liste des actions courantes. "SHARE" permet de partager des fichiers avec d'autres utilisateurs. "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 et versions ultérieures

Propriétés

  • fileSystemId

    chaîne

    Identifiant du système de fichiers à configurer.

  • requestId

    Total

    Identifiant unique de cette requête.

CopyEntryRequestedOptions

Propriétés

  • fileSystemId

    chaîne

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

  • requestId

    Total

    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

    Total

    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

    Total

    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

    Total

    Identifiant unique de cette requête.

EntryMetadata

Propriétés

  • cloudFileInfo

    CloudFileInfo facultatif

    Chrome 125 et versions ultérieures

    Informations permettant d'identifier un fichier spécifique dans le système de fichiers cloud sous-jacent. Doit être fourni s'il est demandé dans options et si le fichier est sauvegardé dans le stockage cloud.

  • cloudIdentifier

    CloudIdentifier facultatif

    Chrome 117 et versions ultérieures

    Représentation Cloud Storage de cette entrée. Doit être fourni s'il est demandé dans options et si le fichier est sauvegardé dans le stockage cloud. Pour les fichiers locaux non sauvegardés dans le stockage cloud, la valeur doit être indéfinie lorsqu'elle est demandée.

  • isDirectory

    booléen facultatif

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

  • mimeType

    chaîne facultative

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

  • modificationTime

    Date facultatif

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

  • nom

    chaîne facultative

    Nom de cette entrée (et non nom de chemin d'accès complet). Ne doit pas contenir de "/". Doit être vide pour la racine. Doit être fourni si demandé dans options.

  • taille

    number facultatif

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

  • miniature

    chaîne facultative

    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 lorsqu'il est explicitement demandé par l'événement onGetMetadataRequested.

ExecuteActionRequestedOptions

Chrome 45 et versions ultérieures

Propriétés

  • actionId

    chaîne

    Identifiant de l'action à exécuter.

  • entryPaths

    chaîne[]

    Chrome 47 et versions ultérieures

    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

    Total

    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

    Liste des fichiers actuellement ouverts.

  • openedFilesLimit

    Total

    Nombre maximal de fichiers pouvant être ouverts simultanément. Si la valeur est définie sur 0, il n'y a pas de limite.

  • supportsNotifyTag

    booléen facultatif

    Chrome 45 et versions ultérieures

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

  • watchers
    Chrome 45 et versions ultérieures

    Liste des observateurs.

  • accessible en écriture

    booléen

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

GetActionsRequestedOptions

Chrome 45 et versions ultérieures

Propriétés

  • entryPaths

    chaîne[]

    Chrome 47 et versions ultérieures

    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

    Total

    Identifiant unique de cette requête.

GetMetadataRequestedOptions

Propriétés

  • cloudFileInfo

    booléen

    Chrome 125 et versions ultérieures

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

  • cloudIdentifier

    booléen

    Chrome 117 et versions ultérieures

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

  • entryPath

    chaîne

    Chemin d'accès à 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

    Chrome 49 et versions ultérieures

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

  • mimeType

    booléen

    Chrome 49 et versions ultérieures

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

  • modificationTime

    booléen

    Chrome 49 et versions ultérieures

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

  • nom

    booléen

    Chrome 49 et versions ultérieures

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

  • requestId

    Total

    Identifiant unique de cette requête.

  • taille

    booléen

    Chrome 49 et versions ultérieures

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

  • miniature

    booléen

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

    number facultatif

    Nombre maximal de fichiers pouvant être ouverts simultanément. Si aucune valeur n'est spécifiée ou si la valeur est définie sur 0, il n'y a pas de limite.

  • SSD

    booléen facultatif

    Chrome 64 et versions ultérieures

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

  • supportsNotifyTag

    booléen facultatif

    Chrome 45 et versions ultérieures

    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 est compatible avec les opérations susceptibles de modifier le contenu du système de fichiers (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

    Total

    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

    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 facultative

    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

    Total

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

OpenFileMode

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

Énumération

"LIRE"

"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

    Total

    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 fournies en réponse aux requêtes, ainsi qu'en cas d'erreur lors de l'appel des 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

    Chrome 49 et versions ultérieures

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

  • mimeType

    booléen

    Chrome 49 et versions ultérieures

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

  • modificationTime

    booléen

    Chrome 49 et versions ultérieures

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

  • nom

    booléen

    Chrome 49 et versions ultérieures

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

  • requestId

    Total

    Identifiant unique de cette requête.

  • taille

    booléen

    Chrome 49 et versions ultérieures

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

  • miniature

    booléen

    Chrome 49 et versions ultérieures

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

    Total

    Nombre d'octets à renvoyer.

  • offset

    Total

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

  • openRequestId

    Total

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

  • requestId

    Total

    Identifiant unique de cette requête.

RemoveWatcherRequestedOptions

Propriétés

  • entryPath

    chaîne

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

  • fileSystemId

    chaîne

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

  • RECURSIVE

    booléen

    Mode de l'observateur.

  • requestId

    Total

    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

    Total

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

  • requestId

    Total

    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

    Total

    Identifiant unique de cette requête.

Watcher

Propriétés

  • entryPath

    chaîne

    Chemin de l'entrée observée.

  • lastTag

    chaîne facultative

    Tag utilisé par la dernière notification pour le spectateur.

  • RECURSIVE

    booléen

    Indique si la surveillance doit inclure toutes les entrées enfants de manière récursive. La valeur "true" ne peut être définie que pour les répertoires.

WriteFileRequestedOptions

Propriétés

  • données

    ArrayBuffer

    Mémoire tampon d'octets à écrire dans le fichier.

  • fileSystemId

    chaîne

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

  • offset

    Total

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

  • openRequestId

    Total

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

  • requestId

    Total

    Identifiant unique de cette requête.

Méthodes

get()

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

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

Paramètres

  • fileSystemId

    chaîne

Renvoie

getAll()

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

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

Renvoie

mount()

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

Installe un système de fichiers avec les fileSystemId et displayName indiqué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 pas nécessairement unique. fileSystemId ne doit pas être une chaîne vide.

Selon le type de système de fichiers à installer, 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 et versions ultérieures

notify()

Chrome 45 et versions ultérieures
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
)
: Promise<void>

Envoie une notification en cas de modification du répertoire surveillé à observedPath en mode recursive. Si le système de fichiers est monté avec supportsNotifyTag, tag doit être fourni et 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 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. Il est donc possible 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 survenues 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 le sont également. 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 leurs chemins d'origine.

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

Paramètres

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

unmount()

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

Désinstalle un système de fichiers avec le 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 démonter le système de fichiers 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 et versions ultérieures

Événements

onAbortRequested

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

Générée lorsqu'une demande d'interruption d'une opération avec operationRequestId est effectuée. L'opération exécutée avec operationRequestId doit être immédiatement arrêtée et successCallback de cette demande d'abandon exécutée. Si l'abandon é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 arrêtée 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 et versions ultérieures
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Générée lorsqu'une nouvelle configuration d'observateur de répertoire est demandée. En cas d'erreur, 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

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

Générée lorsqu'il est demandé de fermer un fichier précédemment ouvert avec openRequestId.

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 et versions ultérieures
chrome.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 file_system_provider.configurable du fichier manifeste 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

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

Générée lorsqu'une copie d'une entrée (de manière récursive s'il s'agit d'un répertoire) est demandée. En cas d'erreur, 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

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

Générée lorsqu'une demande de création d'un 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

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

Générée 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

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

Généré lorsqu'une demande de suppression d'une entrée est envoyé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 et versions ultérieures
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Générée 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 et versions ultérieures
chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

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

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

Générée lorsque les métadonnées d'un fichier ou d'un répertoire à 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 44 et versions ultérieures
chrome.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

Déclenché lorsqu'une boîte de dialogue est demandée pour monter un nouveau système de fichiers. Si l'extension/l'application est un gestionnaire de fichiers, cet événement ne doit pas être géré. Au lieu de cela, app.runtime.onLaunched doit être géré pour monter de nouveaux systèmes de fichiers lorsqu'un fichier est ouvert. Pour plusieurs montages, 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

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

Générée lorsqu'une entrée (de manière récursive s'il s'agit d'un répertoire) est déplacée. En cas d'erreur, 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

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

Générée lorsqu'une demande d'ouverture d'un fichier à 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

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

Générée lorsque le contenu d'un répertoire à directoryPath est demandé. Les résultats doivent être renvoyés par blocs 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 lorsqu'une lecture du contenu d'un fichier précédemment ouvert avec openRequestId est demandée. Les résultats doivent être renvoyés par blocs 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 et versions ultérieures
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

Générée lorsque l'observateur doit être supprimé. En cas d'erreur, 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

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

Générée lorsqu'une demande de troncature d'un fichier à une longueur souhaitée est effectuée. En cas d'erreur, 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

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

Générée lorsqu'une demande de démontage du système de fichiers avec l'identifiant fileSystemId est effectuée. Dans la réponse, la méthode d'API unmount doit être appelée avec successCallback. Si le démontage n'est pas possible (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

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

Générée lorsqu'une écriture de contenu 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