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. По умолчанию: ложь.
multiple_mounts (логическое значение) – необязательно
Поддерживаются ли несколько (более одной) смонтированных файловых систем. По умолчанию: ложь.
watchable (логический) — необязательно
Поддерживается ли установка наблюдателей и уведомление об изменениях. По умолчанию: ложь.
source (перечисление «файл», «устройство» или «сеть») — обязательно.
Источник данных для смонтированных файловых систем.

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

Обзор

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

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

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

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

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

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

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

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

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

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

Типы

AbortRequestedOptions

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

  • fileSystemId

    нить

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

  • идентификатор операцииRequestId

    число

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

  • идентификатор запроса

    число

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

Action

Хром 45+

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

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

    нить

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

  • заголовок

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

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

AddWatcherRequestedOptions

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

  • путь входа

    нить

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

  • fileSystemId

    нить

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

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

    логическое значение

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

  • идентификатор запроса

    число

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

Change

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

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

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

  • облакофайлинфо

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

    Хром 125+

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

  • путь входа

    нить

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

ChangeType

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

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

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

"УДАЛЕНО"

CloseFileRequestedOptions

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

  • fileSystemId

    нить

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

  • openRequestId

    число

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

  • идентификатор запроса

    число

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

CloudFileInfo

Хром 125+

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

  • тег версии

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

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

CloudIdentifier

Хром 117+

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

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

    нить

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

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

    нить

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

CommonActionId

Хром 45+

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

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

"SAVE_FOR_OFFLINE"

"OFFLINE_NOT_NECESSARY"

"ДЕЛИТЬСЯ"

ConfigureRequestedOptions

Хром 44+

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

  • fileSystemId

    нить

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

  • идентификатор запроса

    число

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

CopyEntryRequestedOptions

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

  • fileSystemId

    нить

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

  • идентификатор запроса

    число

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

  • исходный путь

    нить

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

  • целевой путь

    нить

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

CreateDirectoryRequestedOptions

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

  • путь к каталогу

    нить

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

  • fileSystemId

    нить

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

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

    логическое значение

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

  • идентификатор запроса

    число

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

CreateFileRequestedOptions

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

  • путь к файлу

    нить

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

  • fileSystemId

    нить

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

  • идентификатор запроса

    число

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

DeleteEntryRequestedOptions

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

  • путь входа

    нить

    Путь к записи, которую нужно удалить.

  • fileSystemId

    нить

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

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

    логическое значение

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

  • идентификатор запроса

    число

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

EntryMetadata

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

  • облакофайлинфо

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

    Хром 125+

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

  • CloudIdentifier

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

    Хром 117+

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

  • isDirectory

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

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

  • mimeType

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

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

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

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

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

  • имя

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

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

  • размер

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

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

  • миниатюра

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

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

ExecuteActionRequestedOptions

Хром 45+

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

  • идентификатор действия

    нить

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

  • пути входа

    нить[]

    Хром 47+

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

  • fileSystemId

    нить

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

  • идентификатор запроса

    число

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

FileSystemInfo

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

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

    нить

    Понятное для человека имя файловой системы.

  • fileSystemId

    нить

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

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

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

  • OpenFilesLimit

    число

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

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

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

    Хром 45+

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

  • наблюдатели
    Хром 45+

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

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

    логическое значение

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

GetActionsRequestedOptions

Хром 45+

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

  • пути входа

    нить[]

    Хром 47+

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

  • fileSystemId

    нить

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

  • идентификатор запроса

    число

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

GetMetadataRequestedOptions

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

  • облакофайлинфо

    логическое значение

    Хром 125+

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

  • CloudIdentifier

    логическое значение

    Хром 117+

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

  • путь входа

    нить

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

  • fileSystemId

    нить

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

  • isDirectory

    логическое значение

    Хром 49+

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

  • mimeType

    логическое значение

    Хром 49+

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

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

    логическое значение

    Хром 49+

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

  • имя

    логическое значение

    Хром 49+

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

  • идентификатор запроса

    число

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

  • размер

    логическое значение

    Хром 49+

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

  • миниатюра

    логическое значение

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

MountOptions

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

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

    нить

    Понятное для человека имя файловой системы.

  • fileSystemId

    нить

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

  • OpenFilesLimit

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

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

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

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

    Хром 64+

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

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

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

    Хром 45+

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

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

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

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

MoveEntryRequestedOptions

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

  • fileSystemId

    нить

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

  • идентификатор запроса

    число

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

  • исходный путь

    нить

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

  • целевой путь

    нить

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

NotifyOptions

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

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

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

  • изменения

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

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

  • fileSystemId

    нить

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

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

    нить

    Путь наблюдаемой записи.

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

    логическое значение

    Режим наблюдаемой записи.

  • ярлык

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

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

OpenedFile

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

  • путь к файлу

    нить

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

  • режим

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

  • openRequestId

    число

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

OpenFileMode

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

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

"ЧИТАТЬ"

"ПИСАТЬ"

OpenFileRequestedOptions

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

  • путь к файлу

    нить

    Путь к файлу, который нужно открыть.

  • fileSystemId

    нить

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

  • режим

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

  • идентификатор запроса

    число

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

ProviderError

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

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

"ХОРОШО"

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

"IN_USE"

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

"НЕ НАЙДЕНО"

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

"TOO_MANY_OPENED"

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

"NO_SPACE"

"НЕ_А_КАТАЛОГ"

"ИНВАЛИД_ОПЕРАЦИЯ"

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

«АБОРТ»

"НЕ_ФАЙЛ"

"НЕ_ПУСТОЙ"

"INVALID_URL"

"ИО"

ReadDirectoryRequestedOptions

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

  • путь к каталогу

    нить

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

  • fileSystemId

    нить

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

  • isDirectory

    логическое значение

    Хром 49+

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

  • mimeType

    логическое значение

    Хром 49+

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

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

    логическое значение

    Хром 49+

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

  • имя

    логическое значение

    Хром 49+

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

  • идентификатор запроса

    число

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

  • размер

    логическое значение

    Хром 49+

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

  • миниатюра

    логическое значение

    Хром 49+

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

ReadFileRequestedOptions

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

  • fileSystemId

    нить

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

  • длина

    число

    Количество байт, которое должно быть возвращено.

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

    число

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

  • openRequestId

    число

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

  • идентификатор запроса

    число

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

RemoveWatcherRequestedOptions

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

  • путь входа

    нить

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

  • fileSystemId

    нить

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

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

    логическое значение

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

  • идентификатор запроса

    число

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

TruncateRequestedOptions

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

  • путь к файлу

    нить

    Путь к файлу, который нужно обрезать.

  • fileSystemId

    нить

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

  • длина

    число

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

  • идентификатор запроса

    число

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

UnmountOptions

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

  • fileSystemId

    нить

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

UnmountRequestedOptions

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

  • fileSystemId

    нить

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

  • идентификатор запроса

    число

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

Watcher

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

  • путь входа

    нить

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

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

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

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

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

    логическое значение

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

WriteFileRequestedOptions

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

  • данные

    МассивБуфер

    Буфер байтов, которые будут записаны в файл.

  • fileSystemId

    нить

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

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

    число

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

  • openRequestId

    число

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

  • идентификатор запроса

    число

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

Методы

get()

Обещать
chrome.fileSystemProvider.get(
  fileSystemId: string,
  callback?: function,
)

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

Параметры

Возврат

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

    Хром 96+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

getAll()

Обещать
chrome.fileSystemProvider.getAll(
  callback?: function,
)

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

Параметры

Возврат

  • Обещание < FileSystemInfo []>

    Хром 96+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

mount()

Обещать
chrome.fileSystemProvider.mount(
  options: MountOptions,
  callback?: function,
)

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

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

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

Параметры

Возврат

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

    Хром 96+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

notify()

Обещание Chrome 45+
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
  callback?: function,
)

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

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

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

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

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

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

Параметры

  • параметры
  • перезвонить

    функция необязательна

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

    () => void

Возврат

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

    Хром 96+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

unmount()

Обещать
chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
  callback?: function,
)

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

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

Параметры

Возврат

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

    Хром 96+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

События

onAbortRequested

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

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

Параметры

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

    функция

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

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

onAddWatcherRequested

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

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

Параметры

onCloseFileRequested

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

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

Параметры

onConfigureRequested

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

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

Параметры

onCopyEntryRequested

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

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

Параметры

onCreateDirectoryRequested

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

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

Параметры

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

    функция

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

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

onCreateFileRequested

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

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

Параметры

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

    функция

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

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

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

      функция

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

      () => void

    • ошибкаОбратный вызов

      функция

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

      (error: ProviderError) => void

onDeleteEntryRequested

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

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

Параметры

onExecuteActionRequested

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

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

Параметры

onGetActionsRequested

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

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

Параметры

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

    функция

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

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

onGetMetadataRequested

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

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

Параметры

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 выглядит так:

      (error: ProviderError) => void

onMoveEntryRequested

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

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

Параметры

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

    функция

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

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

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

      функция

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

      () => void

    • ошибкаОбратный вызов

      функция

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

      (error: ProviderError) => void

onOpenFileRequested

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

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

Параметры

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

    функция

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

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

onReadDirectoryRequested

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

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

Параметры

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

    функция

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

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

onReadFileRequested

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

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

Параметры

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

    функция

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

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

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

      функция

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

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

      • данные

        МассивБуфер

      • имеетЕще

        логическое значение

    • ошибкаОбратный вызов

      функция

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

      (error: ProviderError) => void

onRemoveWatcherRequested

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

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

Параметры

onTruncateRequested

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

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

Параметры

onUnmountRequested

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

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

Параметры

onWriteFileRequested

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

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

Параметры

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

    функция

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

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

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

      функция

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

      () => void

    • ошибкаОбратный вызов

      функция

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

      (error: ProviderError) => void