ChromeFileSystemProvider class
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
isAvailable
→ bool
-
no setter
-
onAbortRequested
→ EventStream<OnAbortRequestedEvent>
-
Raised when aborting an operation with
operationRequestId
is requested. The operation executed with operationRequestId
must be immediately stopped and successCallback of this
abort request executed. If aborting fails, then
errorCallback must be called. Note, that callbacks of the
aborted operation must not be called, as they will be ignored. Despite
calling errorCallback, the request may be forcibly aborted.
no setter
-
onAddWatcherRequested
→ EventStream<OnAddWatcherRequestedEvent>
-
Raised when setting a new directory watcher is requested. If an error
occurs, then
errorCallback must be called.
no setter
-
onCloseFileRequested
→ EventStream<OnCloseFileRequestedEvent>
-
Raised when opening a file previously opened with
openRequestId is requested to be closed.
no setter
-
onConfigureRequested
→ EventStream<OnConfigureRequestedEvent>
-
Raised when showing a configuration dialog for
fileSystemId
is requested. If it's handled, the
file_system_provider.configurable manfiest option must be
set to true.
no setter
-
onCopyEntryRequested
→ EventStream<OnCopyEntryRequestedEvent>
-
Raised when copying an entry (recursively if a directory) is requested.
If an error occurs, then
errorCallback must be called.
no setter
-
onCreateDirectoryRequested
→ EventStream<OnCreateDirectoryRequestedEvent>
-
Raised when creating a directory is requested. The operation must fail
with the EXISTS error if the target directory already exists.
If
recursive is true, then all of the missing directories
on the directory path must be created.
no setter
-
onCreateFileRequested
→ EventStream<OnCreateFileRequestedEvent>
-
Raised when creating a file is requested. If the file already exists,
then
errorCallback must be called with the
"EXISTS" error code.
no setter
-
onDeleteEntryRequested
→ EventStream<OnDeleteEntryRequestedEvent>
-
Raised when deleting an entry is requested. If
recursive is
true, and the entry is a directory, then all of the entries inside
must be recursively deleted as well.
no setter
-
onExecuteActionRequested
→ EventStream<OnExecuteActionRequestedEvent>
-
Raised when executing an action for a set of files or directories is
requested. After the action is completed, successCallback
must be called. On error, errorCallback must be called.
no setter
-
onGetActionsRequested
→ EventStream<OnGetActionsRequestedEvent>
-
Raised when a list of actions for a set of files or directories at
entryPaths is requested. All of the returned actions must
be applicable to each entry. If there are no such actions, an empty array
should be returned. The actions must be returned with the
successCallback call. In case of an error,
errorCallback must be called.
no setter
-
onGetMetadataRequested
→ EventStream<OnGetMetadataRequestedEvent>
-
Raised when metadata of a file or a directory at
entryPath
is requested. The metadata must be returned with the
successCallback call. In case of an error,
errorCallback must be called.
no setter
-
onMountRequested
→ EventStream<OnMountRequestedEvent>
-
Raised when showing a dialog for mounting a new file system is requested.
If the extension/app is a file handler, then this event shouldn't be
handled. Instead
app.runtime.onLaunched should be handled in
order to mount new file systems when a file is opened. For multiple
mounts, the file_system_provider.multiple_mounts manifest
option must be set to true.
no setter
-
onMoveEntryRequested
→ EventStream<OnMoveEntryRequestedEvent>
-
Raised when moving an entry (recursively if a directory) is requested.
If an error occurs, then
errorCallback must be called.
no setter
-
onOpenFileRequested
→ EventStream<OnOpenFileRequestedEvent>
-
Raised when opening a file at
filePath is requested. If the
file does not exist, then the operation must fail. Maximum number of
files opened at once can be specified with MountOptions.
no setter
-
onReadDirectoryRequested
→ EventStream<OnReadDirectoryRequestedEvent>
-
Raised when contents of a directory at
directoryPath are
requested. The results must be returned in chunks by calling the
successCallback several times. In case of an error,
errorCallback must be called.
no setter
-
onReadFileRequested
→ EventStream<OnReadFileRequestedEvent>
-
Raised when reading contents of a file opened previously with
openRequestId is requested. The results must be returned in
chunks by calling successCallback several times. In case of
an error, errorCallback must be called.
no setter
-
onRemoveWatcherRequested
→ EventStream<OnRemoveWatcherRequestedEvent>
-
Raised when the watcher should be removed. If an error occurs, then
errorCallback must be called.
no setter
-
onTruncateRequested
→ EventStream<OnTruncateRequestedEvent>
-
Raised when truncating a file to a desired length is requested.
If an error occurs, then
errorCallback must be called.
no setter
-
onUnmountRequested
→ EventStream<OnUnmountRequestedEvent>
-
Raised when unmounting for the file system with the
fileSystemId identifier is requested. In the response, the
unmount API method must be called together with
successCallback. If unmounting is not possible (eg. due to
a pending operation), then errorCallback must be called.
no setter
-
onWriteFileRequested
→ EventStream<OnWriteFileRequestedEvent>
-
Raised when writing contents to a file opened previously with
openRequestId is requested.
no setter
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
get(String fileSystemId)
→ Future<FileSystemInfo>
-
Returns information about a file system with the passed
fileSystemId.
-
getAll()
→ Future<List<FileSystemInfo>>
-
Returns all file systems mounted by the extension.
-
mount(MountOptions options)
→ Future<void>
-
Mounts a file system with the given
fileSystemId and
displayName. displayName will be shown in the
left panel of the Files app. displayName can contain any
characters including '/', but cannot be an empty string.
displayName must be descriptive but doesn't have to be
unique. The fileSystemId must not be an empty string.
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
notify(NotifyOptions options)
→ Future<void>
-
Notifies about changes in the watched directory at
observedPath in recursive mode. If the file
system is mounted with supportsNotifyTag, then
tag must be provided, and all changes since the last
notification always reported, even if the system was shutdown. The last
tag can be obtained with getAll.
-
toString()
→ String
-
A string representation of this object.
inherited
-
unmount(UnmountOptions options)
→ Future<void>
-
Unmounts a file system with the given
fileSystemId. It
must be called after onUnmountRequested is invoked. Also,
the providing extension can decide to perform unmounting if not requested
(eg. in case of lost connection, or a file error).
