Description
Utilisez l'API chrome.fileSystemProvider
pour créer des systèmes de fichiers accessibles depuis le gestionnaire de fichiers sur Chrome OS.
Autorisations
fileSystemProvider
Garantie de disponibilité
Manifest
Pour utiliser l'API File SystemProvider, vous devez déclarer l'autorisation et la section "fileSystemProvider" dans le fichier manifeste de l'extension. 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 pris en charge. Par défaut : "false".
watchable
(booléen) : facultatif- Il est possible de définir des observateurs et de signaler les modifications. 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 afin d'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 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, ajoutez 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 et 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 (tel qu'un serveur distant ou un périphérique 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 | le 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 des contenus via le réseau afin de définir des identifiants corrects. 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 sont réinstallés automatiquement après le redémarrage ou le redémarrage. Par conséquent, lorsqu'un système de fichiers est installé par une extension fournissant, 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
ID de la requête à annuler.
-
requestId
Nombre
Identifiant unique de cette requête.
Action
Propriétés
-
id
chaîne
Identifiant de l'action. Toute chaîne ou
CommonActionId
pour les actions courantes -
title
string facultatif
Titre de l'action. Il peut être ignoré 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
boolean
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
Type de modification apportée à l'entrée.
-
cloudFileInfo
CloudFileInfo facultatif
Chrome 125 et versions ultérieuresInformations concernant le fichier si celui-ci est sauvegardé par un système de fichiers dans le cloud.
-
entryPath
chaîne
Chemin d'accès à l'entrée modifiée.
ChangeType
Type de modification détectée dans le répertoire observé.
Enum
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
Propriétés
-
versionTag
string facultatif
Tag qui représente la version du fichier.
CloudIdentifier
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
Liste des actions courantes. "SHARE"
permet de partager des fichiers avec d'autres utilisateurs. "SAVE_FOR_OFFLINE"
pour l'épinglage (enregistrement pour l'accès hors connexion). "OFFLINE_NOT_NECESSARY"
pour indiquer que le fichier n'a plus besoin d'être stocké pour être accessible hors connexion. Utilisé par onGetActionsRequested
et onExecuteActionRequested
.
Enum
ConfigureRequestedOptions
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 pour 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
boolean
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
boolean
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 et versions ultérieuresInformations qui identifient un fichier spécifique dans le système de fichiers cloud sous-jacent. Doit être fourni sur demande dans
options
. Le fichier est sauvegardé dans Cloud Storage. -
cloudIdentifier
CloudIdentifier facultatif
Chrome 117 et versions ultérieuresReprésentation Cloud Storage de cette entrée. Doit être fourni sur demande dans
options
. Le fichier est sauvegardé dans Cloud Storage. Pour les fichiers locaux qui ne sont pas sauvegardés par Cloud Storage, ce paramètre ne doit pas être défini sur demande. -
isDirectory
Booléen facultatif
"True" s'il s'agit d'un répertoire. Doit être fourni sur demande dans
options
. -
mimeType
string facultatif
Type MIME de l'entrée. Toujours facultatif, mais doit être fourni sur demande dans
options
. -
modificationTime
Date facultatif
Heure de la dernière modification de cette entrée. Doit être fourni sur demande dans
options
. -
name
string 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 sur demande dans
options
. -
taille
numéro facultatif
Taille du fichier en octets. Doit être fourni sur demande dans
options
. -
thumbnail
string facultatif
Vignette en tant qu'URI de données au format PNG, JPEG ou WEBP, d'une taille maximale de 32 Ko. Facultatif, mais ne peut être fourni que sur demande explicite par l'événement
onGetMetadataRequested
.
ExecuteActionRequestedOptions
Propriétés
-
actionId
chaîne
Identifiant de l'action à exécuter.
-
entryPaths
chaîne[]
Chrome 47 ou version ultérieureEnsemble 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
Liste des fichiers actuellement ouverts.
-
openedFilesLimit
Nombre
Nombre maximal de fichiers pouvant être ouverts simultanément. Si la valeur est 0, cela signifie qu'il n'est pas limité.
-
supportsNotifyTag
Booléen facultatif
Chrome 45 ou version ultérieureIndique si le système de fichiers accepte le champ
tag
pour observer les répertoires. -
spectateursChrome 45 ou version ultérieure
Liste des observateurs.
-
accessible en écriture
boolean
Indique si le système de fichiers prend en charge des opérations susceptibles de modifier son contenu (comme la création, la suppression ou l'écriture dans des fichiers).
GetActionsRequestedOptions
Propriétés
-
entryPaths
chaîne[]
Chrome 47 ou version ultérieureListe des chemins d'accès aux entrées de la liste d'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
boolean
Chrome 125 et versions ultérieuresDéfinissez-le sur
true
si une valeurcloudFileInfo
est demandée. -
cloudIdentifier
boolean
Chrome 117 et versions ultérieuresDéfinissez-le sur
true
si une valeurcloudIdentifier
est demandée. -
entryPath
chaîne
Chemin de l'entrée pour lequel extraire les métadonnées.
-
fileSystemId
chaîne
Identifiant du système de fichiers associé à cette opération.
-
isDirectory
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeuris_directory
est demandée. -
mimeType
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeurmimeType
est demandée. -
modificationTime
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeurmodificationTime
est demandée. -
name
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeurname
est demandée. -
requestId
Nombre
Identifiant unique de cette requête.
-
taille
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeursize
est demandée. -
thumbnail
boolean
Définissez-le sur
true
si une valeurthumbnail
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. Si aucune valeur n'est spécifiée, ou s'il est égal à 0, cette valeur n'est pas limitée.
-
SSD
Booléen facultatif
Chrome 64 ou version ultérieureIndique si le framework doit reprendre le système de fichiers à la prochaine session de connexion. "True" par défaut.
-
supportsNotifyTag
Booléen facultatif
Chrome 45 ou version ultérieureIndique si le système de fichiers accepte 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 son contenu (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 pour l'opération de copie.
NotifyOptions
Propriétés
-
changeType
Type de 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 d'accès à l'entrée observée.
-
RECURSIVE
boolean
Mode de l'entrée observée.
-
tag
string facultatif
Tag pour 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é modifiées même lorsque le système a été arrêté.
OpenedFile
Propriétés
-
filePath
chaîne
Chemin d'accès au fichier ouvert.
-
Standard
Indique si le fichier a été ouvert en lecture ou en écriture.
-
openRequestId
Nombre
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
.
Enum
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.
-
Standard
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 de méthodes de l'API. Pour réussir, "OK"
doit être utilisé.
Enum
"OK"
"FAILED"
"IN_USE"
"NOT_FOUND"
"ACCESS_DENIED"
"TOO_MANY_OPENED"
"NO_MEMORY"
"NO_SPACE"
"NOT_A_DIRECTORY"
"INVALID_OPERATION"
"ABORT"
"NOT_A_FILE"
"INVALID_URL"
"IO"
ReadDirectoryRequestedOptions
Propriétés
-
directoryPath
chaîne
Chemin du répertoire dont les contenus sont demandés.
-
fileSystemId
chaîne
Identifiant du système de fichiers associé à cette opération.
-
isDirectory
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeuris_directory
est demandée. -
mimeType
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeurmimeType
est demandée. -
modificationTime
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeurmodificationTime
est demandée. -
name
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeurname
est demandée. -
requestId
Nombre
Identifiant unique de cette requête.
-
taille
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeursize
est demandée. -
thumbnail
boolean
Chrome 49 ou version ultérieureDéfinissez-le sur
true
si une valeurthumbnail
est demandée.
ReadFileRequestedOptions
Propriétés
-
fileSystemId
chaîne
Identifiant du système de fichiers associé à cette opération.
-
length
Nombre
Nombre d'octets à renvoyer.
-
offset
Nombre
Position à partir de laquelle commencer la lecture dans le fichier (en octets).
-
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
boolean
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.
-
length
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
string facultatif
Tag utilisé par la dernière notification de l'observateur.
-
RECURSIVE
boolean
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 de laquelle commencer l'écriture des octets.
-
openRequestId
Nombre
ID de requête utilisé pour ouvrir le fichier.
-
requestId
Nombre
Identifiant unique de cette requête.
Méthodes
get()
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
fonction facultative
Le paramètre
callback
se présente comme suit :(fileSystem: FileSystemInfo) => void
-
fileSystem
-
Renvoie
-
Promise<FileSystemInfo>
Chrome 96 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.
getAll()
chrome.fileSystemProvider.getAll(
callback?: function,
)
Renvoie tous les systèmes de fichiers installés par l'extension.
Paramètres
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(fileSystems: FileSystemInfo[]) => void
-
fileSystems
-
Renvoie
-
Promise<FileSystemInfo[]>
Chrome 96 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.
mount()
chrome.fileSystemProvider.mount(
options: MountOptions,
callback?: function,
)
Installe un système de fichiers avec les éléments fileSystemId
et displayName
donnés. displayName
s'affiche dans le panneau de gauche de l'appli 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. Le champ 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 le code d'erreur correspondant.
Paramètres
-
options
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :() => void
Renvoie
-
Promise<void>
Chrome 96 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.
notify()
chrome.fileSystemProvider.notify(
options: NotifyOptions,
callback?: function,
)
Notifie les modifications dans le répertoire surveillé sur observedPath
en mode recursive
. Si le système de fichiers est installé avec supportsNotifyTag
, tag
doit être fourni, et toutes les modifications depuis la dernière notification sont toujours signalées, même si le système a été arrêté. Vous pouvez obtenir la dernière balise à l'aide de getAll
.
Pour l'utiliser, l'option file_system_provider.notify
du fichier manifeste doit être définie sur "true".
La valeur de tag
peut être n'importe quelle chaîne unique pour chaque appel. Il est donc possible d'identifier la dernière notification enregistrée. Par exemple, si l'extension de fourniture 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". Il ne peut pas s'agir d'une chaîne vide.
Tous les fournisseurs ne sont pas en mesure de fournir une balise. Toutefois, si le système de fichiers comporte un journal des modifications, la balise peut être, par exemple, un numéro de modification ou 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 effectivement supprimées, car il n'y a plus d'entrées sous leurs chemins d'accès d'origine.
En cas d'erreur, runtime.lastError
sera défini comme code d'erreur correspondant.
Paramètres
-
options
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :() => void
Renvoie
-
Promise<void>
Chrome 96 et versions ultérieuresLes promesses ne sont compatibles qu'avec Manifest V3 et versions ultérieures. Les autres plates-formes doivent utiliser des rappels.
unmount()
chrome.fileSystemProvider.unmount(
options: UnmountOptions,
callback?: function,
)
Désinstalle un système de fichiers avec le fileSystemId
donné. Elle doit être appelée après l'appel de onUnmountRequested
. De plus, l'extension fournissant les informations peut décider d'effectuer un démontage si elle n'est pas demandée (en cas de perte de connexion ou d'erreur de fichier, par exemple).
En cas d'erreur, runtime.lastError
sera défini avec le code d'erreur correspondant.
Paramètres
-
options
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :() => void
Renvoie
-
Promise<void>
Chrome 96 et versions ultérieuresLes 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 lorsque l'annulation d'une opération avec operationRequestId
est demandée. 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'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 annulée de force.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: AbortRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onAddWatcherRequested
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
callback: function,
)
Générée lorsqu'un nouvel observateur de répertoire est demandé. Si une erreur se produit, errorCallback
doit être appelé.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: AddWatcherRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onCloseFileRequested
chrome.fileSystemProvider.onCloseFileRequested.addListener(
callback: function,
)
Générée lors de l'ouverture d'un fichier précédemment ouvert avec openRequestId
fait l'objet d'une demande de fermeture.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: CloseFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onConfigureRequested
chrome.fileSystemProvider.onConfigureRequested.addListener(
callback: function,
)
Générée lorsqu'une boîte de dialogue de configuration est demandée pour fileSystemId
. Si elle est gérée, l'option de manuel file_system_provider.configurable
doit être définie sur "true".
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: ConfigureRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
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
function
Le paramètre
callback
se présente comme suit :(options: CopyEntryRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onCreateDirectoryRequested
chrome.fileSystemProvider.onCreateDirectoryRequested.addListener(
callback: function,
)
Générée lors de la requête de création d'un répertoire. 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 d'accès au répertoire doivent être créés.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: CreateDirectoryRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onCreateFileRequested
chrome.fileSystemProvider.onCreateFileRequested.addListener(
callback: function,
)
Générée lors de la requête de création d'un fichier. Si le fichier existe déjà, errorCallback
doit être appelé avec le code d'erreur "EXISTS"
.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: CreateFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onDeleteEntryRequested
chrome.fileSystemProvider.onDeleteEntryRequested.addListener(
callback: function,
)
Générée lors de la demande de suppression d'une entré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
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: DeleteEntryRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onExecuteActionRequested
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
callback: function,
)
Générée lors de l'exécution d'une action pour 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
function
Le paramètre
callback
se présente comme suit :(options: ExecuteActionRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onGetActionsRequested
chrome.fileSystemProvider.onGetActionsRequested.addListener(
callback: function,
)
Générée lorsqu'une liste d'actions pour un ensemble de fichiers ou de répertoires dans entryPaths
est demandée. Toutes les actions renvoyées doivent être applicables à chaque entrée. En l'absence d'actions de ce type, 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
function
Le paramètre
callback
se présente comme suit :(options: GetActionsRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :(actions: Action[]) => void
-
correctives
Action[]
-
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
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
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: GetMetadataRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :(metadata: EntryMetadata) => void
-
métadonnées
-
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onMountRequested
chrome.fileSystemProvider.onMountRequested.addListener(
callback: function,
)
Générée lorsqu'une boîte de dialogue d'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. Dans le cas de plusieurs installations, l'option file_system_provider.multiple_mounts
du fichier manifeste doit être définie sur "true".
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(successCallback: function, errorCallback: function) => void
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
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é. Si une erreur se produit, errorCallback
doit être appelé.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: MoveEntryRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onOpenFileRequested
chrome.fileSystemProvider.onOpenFileRequested.addListener(
callback: function,
)
Générée lorsque l'ouverture d'un fichier dans filePath
est demandée. 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
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: OpenFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :(metadata?: EntryMetadata) => void
-
métadonnées
EntryMetadata facultatif
-
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onReadDirectoryRequested
chrome.fileSystemProvider.onReadDirectoryRequested.addListener(
callback: function,
)
Générée lorsque le contenu d'un répertoire dans directoryPath
est demandé. Les résultats doivent être renvoyés en fragments en appelant successCallback
plusieurs fois. En cas d'erreur, errorCallback
doit être appelé.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: ReadDirectoryRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :(entries: EntryMetadata[], hasMore: boolean) => void
-
entries
-
hasMore
boolean
-
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onReadFileRequested
chrome.fileSystemProvider.onReadFileRequested.addListener(
callback: function,
)
Générée lors de la requête de lecture du contenu d'un fichier ouvert précédemment avec openRequestId
. Les résultats doivent être renvoyés en fragments en appelant successCallback
plusieurs fois. En cas d'erreur, errorCallback
doit être appelé.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: ReadFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :(data: ArrayBuffer, hasMore: boolean) => void
-
données
ArrayBuffer
-
hasMore
boolean
-
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onRemoveWatcherRequested
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
callback: function,
)
Générée lorsque l'observateur doit être supprimé. Si une erreur se produit, errorCallback
doit être appelé.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: RemoveWatcherRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onTruncateRequested
chrome.fileSystemProvider.onTruncateRequested.addListener(
callback: function,
)
Générée lorsque la troncation d'un fichier à la longueur souhaitée est demandée. Si une erreur se produit, errorCallback
doit être appelé.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: TruncateRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
onUnmountRequested
chrome.fileSystemProvider.onUnmountRequested.addListener(
callback: function,
)
Générée lors de la désinstallation du système de fichiers avec l'identifiant fileSystemId
demandé. 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
function
Le paramètre
callback
se présente comme suit :(options: UnmountRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-
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
est demandé.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(options: WriteFileRequestedOptions, successCallback: function, errorCallback: function) => void
-
options
-
successCallback
function
Le paramètre
successCallback
se présente comme suit :() => void
-
errorCallback
function
Le paramètre
errorCallback
se présente comme suit :(error: ProviderError) => void
-
error
-
-