chrome.fileSystemProvider

Описание

Используйте API chrome.fileSystemProvider для создания файловых систем, к которым можно получить доступ из файлового менеджера в Chrome OS.

Разрешения

fileSystemProvider

Доступность

только ChromeOS

Для использования API поставщика файловой системы необходимо объявить разрешение и раздел «fileSystemProvider» в манифесте расширения . Например:

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

Раздел file_system_provider должен быть объявлен следующим образом:

configurable (логический) — необязательный
Поддерживается ли настройка через onConfigureRequested. По умолчанию: false.
multiple_mounts (логическое значение) — необязательно
Поддерживается ли несколько (более одной) смонтированных файловых систем. По умолчанию: false.
watchable (логический) — необязательный
Поддерживается ли настройка наблюдателей и уведомление об изменениях. По умолчанию: false.
source (перечисление «файл», «устройство» или «сеть») — обязательно
Источник данных для монтируемых файловых систем.

Приложение «Файлы» использует указанную выше информацию для корректной визуализации соответствующих элементов пользовательского интерфейса. Например, если configurable установлен в значение true, будет отображен пункт меню для настройки томов. Аналогично, если multiple_mounts установлен в true , приложение «Файлы» позволит добавлять более одной точки монтирования из пользовательского интерфейса. Если watchable установлен в false , будет отображена кнопка обновления. Обратите внимание, что по возможности следует добавить поддержку наблюдателей, чтобы изменения в файловой системе отражались немедленно и автоматически.

Обзор

API поставщика файловой системы позволяет создавать расширения для поддержки виртуальных файловых систем, доступных в файловом менеджере ChromeOS. Примеры использования включают распаковку архивов и доступ к файлам в облачных сервисах, отличных от Диска.

Монтирование файловых систем

Предоставление расширений может либо предоставлять содержимое файловой системы из внешнего источника (например, удаленного сервера или USB-устройства), либо использовать в качестве входных данных локальный файл (например, архив).

Чтобы написать файловые системы, являющиеся обработчиками файлов (источник — "file" ), поставщик должен быть упакованным приложением, поскольку событие onLaunched недоступно для расширений.

Если источником является сеть или устройство, то файловая система должна быть смонтирована при вызове события onMountRequested .

Источник данных файловой системы Точка входа
"file" Доступно только для пакетных приложений.
"device" или "network" onMountRequested

Настройка файловых систем

После монтирования предоставленные файловые системы можно настроить с помощью события onConfigureRequested . Это особенно полезно для файловых систем, предоставляющих содержимое по сети, для установки корректных учётных данных. Обработка этого события необязательна.

Жизненный цикл

После монтирования предоставленные файловые системы запоминаются Chrome и автоматически перемонтируются после перезагрузки или перезапуска. Таким образом, после монтирования файловой системы предоставляемым расширением она останется подключенной до тех пор, пока расширение не будет выгружено или не вызовет метод unmount .

Типы

AbortRequestedOptions

Характеристики

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • operationRequestId

    число

    Идентификатор запроса, который необходимо отменить.

  • requestId

    число

    Уникальный идентификатор этого запроса.

Action

Хром 45+

Характеристики

  • идентификатор

    нить

    Идентификатор действия. Любая строка или CommonActionId для общих действий.

  • заголовок

    строка необязательная

    Название действия. Для обычных действий его можно игнорировать.

AddWatcherRequestedOptions

Характеристики

  • entryPath

    нить

    Необходимо контролировать путь входа.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • рекурсивный

    булев

    Следует ли при наблюдении рекурсивно включать все дочерние записи? Это может быть верно только для каталогов.

  • requestId

    число

    Уникальный идентификатор этого запроса.

Change

Характеристики

  • изменить тип

    ИзменитьТип

    Тип изменения, произошедшего с записью.

  • cloudFileInfo

    CloudFileInfo необязательно

    Хром 125+

    Информация, относящаяся к файлу, хранится в облачной файловой системе.

  • entryPath

    нить

    Путь измененной записи.

ChangeType

Тип изменения, обнаруженного в наблюдаемом каталоге.

Перечисление

"ИЗМЕНЕННЫЙ"

«УДАЛЕНО»

CloseFileRequestedOptions

Характеристики

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • openRequestId

    число

    Идентификатор запроса, используемый для открытия файла.

  • requestId

    число

    Уникальный идентификатор этого запроса.

CloudFileInfo

Хром 125+

Характеристики

  • версияТег

    строка необязательная

    Тег, представляющий версию файла.

CloudIdentifier

Хром 117+

Характеристики

  • идентификатор

    нить

    Идентификатор провайдера для указанного файла/каталога.

  • Имя_провайдера

    нить

    Идентификатор поставщика облачного хранилища (например, «drive.google.com»).

CommonActionId

Хром 45+

Список распространённых действий. "SHARE" — для обмена файлами с другими. "SAVE_FOR_OFFLINE" — для закрепления (сохранения для офлайн-доступа). "OFFLINE_NOT_NECESSARY" для уведомления о том, что файл больше не требуется сохранять для офлайн-доступа. Используется функциями onGetActionsRequested и onExecuteActionRequested .

Перечисление

"СОХРАНИТЬ_ДЛЯ_ОФФЛАЙН"

"ОФФЛАЙН_НЕ_НУЖЕН"

"ДЕЛИТЬСЯ"

ConfigureRequestedOptions

Хром 44+

Характеристики

  • fileSystemId

    нить

    Идентификатор файловой системы, которую необходимо настроить.

  • requestId

    число

    Уникальный идентификатор этого запроса.

CopyEntryRequestedOptions

Характеристики

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • requestId

    число

    Уникальный идентификатор этого запроса.

  • sourcePath

    нить

    Исходный путь записи, которую необходимо скопировать.

  • targetPath

    нить

    Путь назначения для операции копирования.

CreateDirectoryRequestedOptions

Характеристики

  • directoryPath

    нить

    Путь к создаваемому каталогу.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • рекурсивный

    булев

    Является ли операция рекурсивной (только для каталогов).

  • requestId

    число

    Уникальный идентификатор этого запроса.

CreateFileRequestedOptions

Характеристики

  • filePath

    нить

    Путь к создаваемому файлу.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • requestId

    число

    Уникальный идентификатор этого запроса.

DeleteEntryRequestedOptions

Характеристики

  • entryPath

    нить

    Путь к записи, которую необходимо удалить.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • рекурсивный

    булев

    Является ли операция рекурсивной (только для каталогов).

  • requestId

    число

    Уникальный идентификатор этого запроса.

EntryMetadata

Характеристики

  • cloudFileInfo

    CloudFileInfo необязательно

    Хром 125+

    Информация, идентифицирующая конкретный файл в базовой облачной файловой системе. Должна быть предоставлена, если это запрошено в options , и файл хранится в облачном хранилище.

  • cloudIdentifier

    CloudIdentifier необязательно

    Хром 117+

    Представление этой записи в облачном хранилище. Должна быть предоставлена, если указано в options , и файл хранится в облачном хранилище. Для локальных файлов, не хранящихся в облачном хранилище, при запросе значение должно быть не определено.

  • isDirectory

    логическое необязательное

    True, если это каталог. Должен быть указан, если указано в options .

  • mimeType

    строка необязательная

    Тип MIME для записи. Всегда необязателен, но должен быть указан, если требуется в options .

  • Время модификации

    Дата необязательна

    Время последнего изменения этой записи. Должна быть указана, если указано в options .

  • имя

    строка необязательная

    Имя этой записи (не полный путь). Не должно содержать символ «/». Для root оно должно быть пустым. Необходимо указать, если указано в options .

  • размер

    номер необязательно

    Размер файла в байтах. Должен быть указан, если указано в options .

  • миниатюра

    строка необязательная

    Изображение миниатюры в виде URI данных в формате PNG, JPEG или WEBP, размером не более 32 КБ. Необязательно, но может быть предоставлено только при явном запросе событием onGetMetadataRequested .

ExecuteActionRequestedOptions

Хром 45+

Характеристики

  • actionId

    нить

    Идентификатор действия, которое должно быть выполнено.

  • entryPaths

    нить[]

    Хром 47+

    Набор путей записей, которые будут использоваться для действия.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • requestId

    число

    Уникальный идентификатор этого запроса.

FileSystemInfo

Характеристики

  • отображаемое имя

    нить

    Удобочитаемое имя файловой системы.

  • fileSystemId

    нить

    Идентификатор файловой системы.

  • открытыеФайлы

    ОткрытыйФайл []

    Список открытых в данный момент файлов.

  • открытыеФайлыЛимит

    число

    Максимальное количество файлов, которые можно открыть одновременно. Если 0, то ограничений нет.

  • поддерживаетNotifyTag

    логическое необязательное

    Хром 45+

    Поддерживает ли файловая система поле tag для наблюдения за каталогами.

  • наблюдатели

    Наблюдатель []

    Хром 45+

    Список наблюдателей.

  • записываемый

    булев

    Поддерживает ли файловая система операции, которые могут изменить содержимое файловой системы (например, создание, удаление или запись в файлы).

GetActionsRequestedOptions

Хром 45+

Характеристики

  • entryPaths

    нить[]

    Хром 47+

    Список путей записей для списка действий.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • requestId

    число

    Уникальный идентификатор этого запроса.

GetMetadataRequestedOptions

Характеристики

  • cloudFileInfo

    булев

    Хром 125+

    Установите значение true , если запрашивается значение cloudFileInfo .

  • cloudIdentifier

    булев

    Хром 117+

    Установите значение true , если запрашивается значение cloudIdentifier .

  • entryPath

    нить

    Путь к записи, о которой требуется получить метаданные.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • isDirectory

    булев

    Хром 49+

    Установите значение true , если запрашивается значение is_directory .

  • mimeType

    булев

    Хром 49+

    Установите значение true , если запрашивается значение mimeType .

  • Время модификации

    булев

    Хром 49+

    Установите значение true , если запрашивается значение modificationTime .

  • имя

    булев

    Хром 49+

    Установите значение true , если запрашивается значение name .

  • requestId

    число

    Уникальный идентификатор этого запроса.

  • размер

    булев

    Хром 49+

    Установите значение true , если запрашивается значение size .

  • миниатюра

    булев

    Установите значение true , если запрашивается значение thumbnail .

MountOptions

Характеристики

  • отображаемое имя

    нить

    Удобочитаемое имя файловой системы.

  • fileSystemId

    нить

    Строковый идентификатор файловой системы. Должен быть уникальным для каждого расширения.

  • открытыеФайлыЛимит

    номер необязательно

    Максимальное количество файлов, которые можно открыть одновременно. Если не указано или равно 0, то ограничений нет.

  • настойчивый

    логическое необязательное

    Chrome 64+

    Должен ли фреймворк возобновлять работу файловой системы при следующем сеансе входа в систему. Значение по умолчанию — true.

  • поддерживаетNotifyTag

    логическое необязательное

    Хром 45+

    Поддерживает ли файловая система поле tag для наблюдаемых каталогов.

  • записываемый

    логическое необязательное

    Поддерживает ли файловая система операции, которые могут изменить содержимое файловой системы (например, создание, удаление или запись в файлы).

MoveEntryRequestedOptions

Характеристики

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • requestId

    число

    Уникальный идентификатор этого запроса.

  • sourcePath

    нить

    Исходный путь записи, которую необходимо перенести на новое место.

  • targetPath

    нить

    Путь назначения для операции копирования.

NotifyOptions

Характеристики

  • изменить тип

    ИзменитьТип

    Тип изменения, произошедшего с наблюдаемой записью. Если он УДАЛЁН, то наблюдаемая запись будет автоматически удалена из списка наблюдаемых записей.

  • изменения

    Изменить [] необязательно

    Список изменений записей в наблюдаемом каталоге (включая саму запись)

  • fileSystemId

    нить

    Идентификатор файловой системы, связанной с этим изменением.

  • наблюдаемый путь

    нить

    Путь наблюдаемого входа.

  • рекурсивный

    булев

    Режим наблюдаемого входа.

  • ярлык

    строка необязательная

    Тег для уведомления. Требуется, если файловая система была смонтирована с опцией supportsNotifyTag . Обратите внимание, что этот флаг необходим для предоставления уведомлений об изменениях, которые произошли даже после завершения работы системы.

OpenedFile

Характеристики

  • filePath

    нить

    Путь к открытому файлу.

  • режим

    OpenFileMode

    Был ли файл открыт для чтения или записи.

  • openRequestId

    число

    Идентификатор запроса, который будет использоваться последовательными запросами на чтение/запись и закрытие.

OpenFileMode

Режим открытия файла. Используется onOpenFileRequested .

Перечисление

"ЧИТАТЬ"

"ПИСАТЬ"

OpenFileRequestedOptions

Характеристики

  • filePath

    нить

    Путь к файлу, который необходимо открыть.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • режим

    OpenFileMode

    Будет ли файл использоваться для чтения или записи.

  • requestId

    число

    Идентификатор запроса, который будет использоваться последовательными запросами на чтение/запись и закрытие.

ProviderError

Коды ошибок, используемые при предоставлении расширений в ответ на запросы, а также в случае ошибок при вызове методов API. Для успешного выполнения необходимо использовать "OK" .

Перечисление

"ХОРОШО"

"НЕУСПЕШНЫЙ"

"IN_USE"

«СУЩЕСТВУЕТ»

"НЕ НАЙДЕНО"

"ДОСТУП ЗАПРЕЩЕН"

"TOO_MANY_OPENED"

"НЕТ_ПАМЯТИ"

"NO_SPACE"

"NOT_A_DIRECTORY"

"НЕДОПУСТИМАЯ_ОПЕРАЦИЯ"

"БЕЗОПАСНОСТЬ"

"АВОР"

"NOT_A_FILE"

"НЕ_ПУСТО"

"INVALID_URL"

"ИО"

ReadDirectoryRequestedOptions

Характеристики

  • directoryPath

    нить

    Путь к каталогу, содержимое которого запрашивается.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • isDirectory

    булев

    Хром 49+

    Установите значение true , если запрашивается значение is_directory .

  • mimeType

    булев

    Хром 49+

    Установите значение true , если запрашивается значение mimeType .

  • Время модификации

    булев

    Хром 49+

    Установите значение true , если запрашивается значение modificationTime .

  • имя

    булев

    Хром 49+

    Установите значение true , если запрашивается значение name .

  • requestId

    число

    Уникальный идентификатор этого запроса.

  • размер

    булев

    Хром 49+

    Установите значение true , если запрашивается значение size .

  • миниатюра

    булев

    Хром 49+

    Установите значение true , если запрашивается значение thumbnail .

ReadFileRequestedOptions

Характеристики

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • длина

    число

    Количество возвращаемых байтов.

  • компенсировать

    число

    Позиция в файле (в байтах), с которой следует начать чтение.

  • openRequestId

    число

    Идентификатор запроса, используемый для открытия файла.

  • requestId

    число

    Уникальный идентификатор этого запроса.

RemoveWatcherRequestedOptions

Характеристики

  • entryPath

    нить

    Путь наблюдаемого входа.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • рекурсивный

    булев

    Режим наблюдателя.

  • requestId

    число

    Уникальный идентификатор этого запроса.

TruncateRequestedOptions

Характеристики

  • filePath

    нить

    Путь к файлу, который необходимо обрезать.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • длина

    число

    Количество байтов, которые необходимо сохранить после завершения операции.

  • requestId

    число

    Уникальный идентификатор этого запроса.

UnmountOptions

Характеристики

  • fileSystemId

    нить

    Идентификатор файловой системы, которую необходимо размонтировать.

UnmountRequestedOptions

Характеристики

  • fileSystemId

    нить

    Идентификатор файловой системы, которую необходимо размонтировать.

  • requestId

    число

    Уникальный идентификатор этого запроса.

Watcher

Характеристики

  • entryPath

    нить

    Наблюдаемый путь входа.

  • последнийТег

    строка необязательная

    Тег, используемый последним уведомлением для наблюдателя.

  • рекурсивный

    булев

    Следует ли при просмотре рекурсивно включать все дочерние записи. Это может быть верно только для каталогов.

WriteFileRequestedOptions

Характеристики

  • данные

    ArrayBuffer

    Буфер байтов для записи в файл.

  • fileSystemId

    нить

    Идентификатор файловой системы, относящейся к этой операции.

  • компенсировать

    число

    Позиция в файле (в байтах), с которой следует начать запись байтов.

  • openRequestId

    число

    Идентификатор запроса, используемый для открытия файла.

  • requestId

    число

    Уникальный идентификатор этого запроса.

Методы

get()

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

Возвращает информацию о файловой системе с переданным fileSystemId .

Параметры

  • fileSystemId

    нить

Возврат

getAll()

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

Возвращает все файловые системы, смонтированные расширением.

Возврат

mount()

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

Монтирует файловую систему с заданными fileSystemId и displayName . displayName будет отображаться на левой панели приложения «Файлы». displayName может содержать любые символы, включая «/», но не может быть пустой строкой. displayName должно быть описательным, но не обязательно уникальным. fileSystemId не может быть пустой строкой.

В зависимости от типа монтируемой файловой системы необходимо соответствующим образом настроить параметр source .

В случае ошибки runtime.lastError будет установлен с соответствующим кодом ошибки.

Параметры

Возврат

  • Обещание<void>

    Хром 96+

notify()

Хром 45+
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
): Promise<void>

Уведомляет об изменениях в отслеживаемом каталоге по адресу observedPath в recursive режиме. Если файловая система смонтирована с помощью supportsNotifyTag , необходимо указать tag , и все изменения с момента последнего уведомления всегда будут сообщаться, даже если система была выключена. Последний тег можно получить с помощью getAll .

Для использования параметр манифеста file_system_provider.notify должен быть установлен в значение true.

Значение tag может быть любой строкой, уникальной для каждого вызова, что позволяет определить последнее зарегистрированное уведомление. Например, если предоставляющее расширение запускается после перезагрузки, а тег последнего зарегистрированного уведомления равен «123», то необходимо вызвать notify для всех изменений, произошедших с момента изменения, отмеченного тегом «123». Это значение не может быть пустой строкой.

Не все поставщики могут предоставить тег, но если в файловой системе есть журнал изменений, то тегом может быть, например, номер изменения или номер ревизии.

Обратите внимание, что при удалении родительского каталога удаляются и все его дочерние записи, и если за ними ведется наблюдение, API должен быть уведомлен об этом. Кроме того, при переименовании каталога удаляются все его дочерние записи, поскольку по их исходным путям больше нет записей.

В случае ошибки будет установлен runtime.lastError с соответствующим кодом ошибки.

Параметры

Возврат

  • Обещание<void>

    Хром 96+

unmount()

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

Размонтирует файловую систему с заданным fileSystemId . Вызвать этот метод необходимо после вызова onUnmountRequested . Кроме того, предоставляющее расширение может принять решение о размонтировании, если запрос не был выполнен (например, в случае потери соединения или ошибки файла).

В случае ошибки runtime.lastError будет установлен с соответствующим кодом ошибки.

Параметры

Возврат

  • Обещание<void>

    Хром 96+

События

onAbortRequested

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

Возникает при запросе прерывания операции с operationRequestId . Операция, выполняемая с operationRequestId должна быть немедленно остановлена, и выполнена successCallback этого запроса на прерывание. Если прерывание не удалось, необходимо вызвать errorCallback . Обратите внимание, что обратные вызовы прерванной операции вызывать нельзя, так как они будут проигнорированы. Несмотря на вызов errorCallback , запрос может быть принудительно прерван.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      AbortRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onAddWatcherRequested

Хром 45+
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Возникает при запросе установки нового наблюдателя за каталогом. В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      AddWatcherRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onCloseFileRequested

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

Возникает при открытии файла, ранее открытого с помощью openRequestId , поступает запрос на закрытие.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      CloseFileRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onConfigureRequested

Хром 44+
chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

Возникает при запросе отображения диалогового окна конфигурации для fileSystemId . Если ошибка обработана, параметр file_system_provider.configurable manfiest должен быть установлен в значение true.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      ConfigureRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onCopyEntryRequested

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

Возникает при запросе копирования записи (рекурсивно, если это каталог). В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      CopyEntryRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onCreateDirectoryRequested

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

Возникает при запросе создания каталога. Операция должна завершиться ошибкой EXISTS, если целевой каталог уже существует. Если recursive имеет значение true, то все отсутствующие каталоги в пути к каталогу должны быть созданы.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      CreateDirectoryRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onCreateFileRequested

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

Возникает при запросе на создание файла. Если файл уже существует, необходимо вызвать errorCallback с кодом ошибки "EXISTS" .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      CreateFileRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onDeleteEntryRequested

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

Возникает при запросе удаления записи. Если recursive имеет значение true и запись является каталогом, то все записи внутри неё также должны быть рекурсивно удалены.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      DeleteEntryRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onExecuteActionRequested

Хром 48+
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Возникает при запросе выполнения действия для набора файлов или каталогов. После завершения действия необходимо вызвать successCallback . В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      ExecuteActionRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onGetActionsRequested

Хром 48+
chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

Возникает при запросе списка действий для набора файлов или каталогов в entryPaths . Все возвращаемые действия должны быть применимы к каждой записи. Если таких действий нет, должен быть возвращен пустой массив. Действия должны быть возвращены с помощью вызова successCallback . В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      GetActionsRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      (actions: Action[]) => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onGetMetadataRequested

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

Возникает при запросе метаданных файла или каталога по адресу entryPath . Метаданные должны быть возвращены с помощью вызова successCallback . В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

onMountRequested

Хром 44+
chrome.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

Возникает при запросе отображения диалогового окна для монтирования новой файловой системы. Если расширение/приложение является обработчиком файлов, это событие не следует обрабатывать. Вместо этого следует обрабатывать событие app.runtime.onLaunched для монтирования новых файловых систем при открытии файла. Для множественных монтирований параметр манифеста file_system_provider.multiple_mounts должен быть установлен в значение true.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onMoveEntryRequested

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

Возникает при запросе перемещения записи (рекурсивно, если это каталог). В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      MoveEntryRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onOpenFileRequested

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

Возникает при запросе открытия файла по указанному filePath . Если файл не существует, операция завершается ошибкой. Максимальное количество одновременно открываемых файлов можно указать с помощью MountOptions .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      OpenFileRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      (metadata?: EntryMetadata) => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onReadDirectoryRequested

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

Возникает при запросе содержимого каталога по адресу directoryPath . Результаты должны возвращаться частями путём многократного вызова successCallback . В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      ReadDirectoryRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      (entries: EntryMetadata[], hasMore: boolean) => void

      • записи

        EntryMetadata []

      • имеетБольше

        булев

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onReadFileRequested

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

Возникает при запросе чтения содержимого файла, открытого ранее с помощью openRequestId . Результаты должны быть возвращены по частям путем многократного вызова successCallback . В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      ReadFileRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

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

      • данные

        ArrayBuffer

      • имеетБольше

        булев

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onRemoveWatcherRequested

Хром 45+
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

Возникает, когда наблюдателя необходимо удалить. В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      RemoveWatcherRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onTruncateRequested

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

Возникает при запросе усечения файла до требуемой длины. В случае ошибки необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      TruncateRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onUnmountRequested

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

Возникает при запросе размонтирования файловой системы с идентификатором fileSystemId . В ответе необходимо вызвать метод API unmount вместе с successCallback . Если размонтирование невозможно (например, из-за ожидающей операции), необходимо вызвать errorCallback .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      UnmountRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void

onWriteFileRequested

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

Возникает при запросе записи содержимого в файл, открытый ранее с помощью openRequestId .

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • параметры

      WriteFileRequestedOptions

    • успехОбратный звонок

      функция

      Параметр successCallback выглядит так: 

      () => void

    • errorCallback

      функция

      Параметр errorCallback выглядит так: 

      (error: ProviderError) => void