chrome.fileSystemProvider

Descrição

Use a API chrome.fileSystemProvider para criar sistemas de arquivos que podem ser acessados no gerenciador de arquivos do Chrome OS.

Permissões

fileSystemProvider

Disponibilidade

Somente no ChromeOS

Manifesto

Você precisa declarar a permissão e a seção "fileSystemProvider" no manifesto da extensão para usar a API File System Provider. Exemplo:

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

A seção "file_system_provider" precisa ser declarada da seguinte forma:

configurable (booleano): opcional
Se a configuração via onConfigureRequested é compatível. O padrão é "false".
multiple_mounts (booleano): opcional
Indica se vários sistemas de arquivos ativados (mais de um) são compatíveis. O padrão é "false".
watchable (booleano): opcional
Se a definição de observadores e a notificação sobre mudanças são compatíveis. O padrão é "false".
source (enum de "file", "device" ou "network"): obrigatório
Origem dos dados para sistemas de arquivos montados.

O app Arquivos usa as informações acima para renderizar os elementos da interface relacionados de maneira adequada. Por exemplo, se configurable estiver definido como "true", um item de menu para configurar volumes será renderizado. Da mesma forma, se multiple_mounts estiver definido como true, o app Files permitirá adicionar mais de um ponto de montagem na interface. Se watchable for false, um botão de atualização será renderizado. Se possível, adicione suporte a observadores para que as mudanças no sistema de arquivos sejam refletidas imediatamente e de forma automática.

Visão geral

A API File System Provider permite que as extensões ofereçam suporte a sistemas de arquivos virtuais, que estão disponíveis no gerenciador de arquivos do ChromeOS. Os casos de uso incluem descompactar arquivos e acessar arquivos em um serviço de nuvem diferente do Drive.

Montar sistemas de arquivos.

As extensões podem fornecer conteúdo do sistema de arquivos de uma fonte externa (como um servidor remoto ou um dispositivo USB) ou usar um arquivo local (como um arquivo) como entrada.

Para gravar sistemas de arquivos que são gerenciadores de arquivos (a origem é "file"), o provedor precisa ser um app empacotado, já que o evento onLaunched não está disponível para extensões.

Se a origem for uma rede ou um dispositivo, o sistema de arquivos precisará ser montado quando o evento onMountRequested for chamado.

Origem dos dados do sistema de arquivos Ponto de entrada
"file" Disponível apenas para apps empacotados.
"device" ou "network" onMountRequested

Como configurar sistemas de arquivos

Os sistemas de arquivos fornecidos, depois de montados, podem ser configurados pelo evento onConfigureRequested. Isso é especialmente útil para sistemas de arquivos que fornecem conteúdo pela rede para definir as credenciais adequadas. O processamento desse evento é opcional.

Ciclo de vida

Os sistemas de arquivos fornecidos, depois de montados, são lembrados pelo Chrome e remontados automaticamente após uma reinicialização. Portanto, depois que um sistema de arquivos é montado por uma extensão fornecedora, ele permanece até que a extensão seja descarregada ou chame o método unmount.

Tipos

AbortRequestedOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • operationRequestId

    número

    Um ID da solicitação a ser cancelada.

  • requestId

    número

    O identificador exclusivo desta solicitação.

Action

Chrome 45 ou mais recente

Propriedades

  • ID

    string

    O identificador da ação. Qualquer string ou CommonActionId para ações comuns.

  • título

    string opcional

    O título da ação. Ele pode ser ignorado para ações comuns.

AddWatcherRequestedOptions

Propriedades

  • entryPath

    string

    O caminho da entrada a ser observada.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • recursive

    booleano

    Se a observação deve incluir todas as entradas filhas de forma recursiva. Ele só pode ser verdadeiro para diretórios.

  • requestId

    número

    O identificador exclusivo desta solicitação.

Change

Propriedades

  • changeType

    O tipo de mudança que aconteceu na entrada.

  • cloudFileInfo

    CloudFileInfo opcional

    Chrome 125 ou mais recente

    Informações relacionadas ao arquivo se ele for armazenado em um sistema de arquivos na nuvem.

  • entryPath

    string

    O caminho da entrada alterada.

ChangeType

Tipo de mudança detectada no diretório observado.

Enumeração

"CHANGED"

"DELETED"

CloseFileRequestedOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • openRequestId

    número

    Um ID de solicitação usado para abrir o arquivo.

  • requestId

    número

    O identificador exclusivo desta solicitação.

CloudFileInfo

Chrome 125 ou mais recente

Propriedades

  • versionTag

    string opcional

    Uma tag que representa a versão do arquivo.

CloudIdentifier

Chrome 117 ou mais recente

Propriedades

  • ID

    string

    O identificador do provedor para o arquivo/diretório especificado.

  • providerName

    string

    Identificador do provedor de armazenamento em nuvem (por exemplo, "drive.google.com").

CommonActionId

Chrome 45 ou mais recente

Lista de ações comuns. O "SHARE" é para compartilhar arquivos com outras pessoas. "SAVE_FOR_OFFLINE" para fixar (salvar para acesso off-line). "OFFLINE_NOT_NECESSARY" para notificar que o arquivo não precisa mais ser armazenado para acesso off-line. Usado por onGetActionsRequested e onExecuteActionRequested.

Enumeração

"SAVE_FOR_OFFLINE"

"OFFLINE_NOT_NECESSARY"

"COMPARTILHAR"

ConfigureRequestedOptions

Chrome 44 ou mais recente

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos a ser configurado.

  • requestId

    número

    O identificador exclusivo desta solicitação.

CopyEntryRequestedOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • requestId

    número

    O identificador exclusivo desta solicitação.

  • sourcePath

    string

    O caminho de origem da entrada a ser copiada.

  • targetPath

    string

    O caminho de destino para a operação de cópia.

CreateDirectoryRequestedOptions

Propriedades

  • directoryPath

    string

    O caminho do diretório a ser criado.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • recursive

    booleano

    Indica se a operação é recursiva (somente para diretórios).

  • requestId

    número

    O identificador exclusivo desta solicitação.

CreateFileRequestedOptions

Propriedades

  • filePath

    string

    O caminho do arquivo a ser criado.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • requestId

    número

    O identificador exclusivo desta solicitação.

DeleteEntryRequestedOptions

Propriedades

  • entryPath

    string

    O caminho da entrada a ser excluída.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • recursive

    booleano

    Indica se a operação é recursiva (somente para diretórios).

  • requestId

    número

    O identificador exclusivo desta solicitação.

EntryMetadata

Propriedades

  • cloudFileInfo

    CloudFileInfo opcional

    Chrome 125 ou mais recente

    Informações que identificam um arquivo específico no sistema de arquivos da nuvem subjacente. Precisa ser fornecido se solicitado em options e se o arquivo tiver backup do armazenamento em nuvem.

  • cloudIdentifier

    CloudIdentifier opcional

    Chrome 117 ou mais recente

    Representação do Cloud Storage desta entrada. Precisa ser fornecido se solicitado em options e se o arquivo tiver backup do armazenamento em nuvem. Para arquivos locais não armazenados em backup pelo armazenamento em nuvem, ele precisa ser indefinido quando solicitado.

  • isDirectory

    booleano opcional

    Verdadeiro se for um diretório. Precisa ser fornecido se solicitado em options.

  • mimeType

    string opcional

    Tipo MIME da entrada. Sempre opcional, mas precisa ser fornecido se solicitado em options.

  • modificationTime

    Data opcional

    A hora da última modificação desta entrada. Precisa ser fornecido se solicitado em options.

  • nome

    string opcional

    Nome desta entrada (não o nome completo do caminho). Não pode conter "/". Para a raiz, precisa estar vazio. Precisa ser fornecido se solicitado em options.

  • tamanho

    number optional

    Tamanho do arquivo em bytes. Precisa ser fornecido se solicitado em options.

  • miniatura

    string opcional

    Imagem em miniatura como um URI de dados no formato PNG, JPEG ou WEBP, com no máximo 32 KB. Opcional, mas só pode ser fornecido quando explicitamente solicitado pelo evento onGetMetadataRequested.

ExecuteActionRequestedOptions

Chrome 45 ou mais recente

Propriedades

  • actionId

    string

    O identificador da ação a ser executada.

  • entryPaths

    string[]

    Chrome 47 ou mais recente

    O conjunto de caminhos das entradas a serem usadas na ação.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • requestId

    número

    O identificador exclusivo desta solicitação.

FileSystemInfo

Propriedades

  • displayName

    string

    Um nome legível para o sistema de arquivos.

  • fileSystemId

    string

    O identificador do sistema de arquivos.

  • openedFiles

    Lista de arquivos abertos no momento.

  • openedFilesLimit

    número

    O número máximo de arquivos que podem ser abertos de uma só vez. Se for 0, não haverá limite.

  • supportsNotifyTag

    booleano opcional

    Chrome 45 ou mais recente

    Indica se o sistema de arquivos oferece suporte ao campo tag para observar diretórios.

  • observadores
    Chrome 45 ou mais recente

    Lista de observadores.

  • gravável

    booleano

    Se o sistema de arquivos oferece suporte a operações que podem mudar o conteúdo dele (como criar, excluir ou gravar em arquivos).

GetActionsRequestedOptions

Chrome 45 ou mais recente

Propriedades

  • entryPaths

    string[]

    Chrome 47 ou mais recente

    Lista de caminhos de entradas para a lista de ações.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • requestId

    número

    O identificador exclusivo desta solicitação.

GetMetadataRequestedOptions

Propriedades

  • cloudFileInfo

    booleano

    Chrome 125 ou mais recente

    Defina como true se o valor cloudFileInfo for solicitado.

  • cloudIdentifier

    booleano

    Chrome 117 ou mais recente

    Defina como true se o valor cloudIdentifier for solicitado.

  • entryPath

    string

    O caminho da entrada para buscar metadados.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • isDirectory

    booleano

    Chrome 49+

    Defina como true se o valor is_directory for solicitado.

  • mimeType

    booleano

    Chrome 49+

    Defina como true se o valor mimeType for solicitado.

  • modificationTime

    booleano

    Chrome 49+

    Defina como true se o valor modificationTime for solicitado.

  • nome

    booleano

    Chrome 49+

    Defina como true se o valor name for solicitado.

  • requestId

    número

    O identificador exclusivo desta solicitação.

  • tamanho

    booleano

    Chrome 49+

    Defina como true se o valor size for solicitado.

  • miniatura

    booleano

    Defina como true se o valor thumbnail for solicitado.

MountOptions

Propriedades

  • displayName

    string

    Um nome legível para o sistema de arquivos.

  • fileSystemId

    string

    O identificador de string do sistema de arquivos. Precisa ser exclusivo para cada extensão.

  • openedFilesLimit

    number optional

    O número máximo de arquivos que podem ser abertos de uma só vez. Se não for especificado ou for 0, não haverá limite.

  • persistente

    booleano opcional

    Chrome 64 ou mais recente

    Se a estrutura precisa retomar o sistema de arquivos na próxima sessão de login. "True" por padrão.

  • supportsNotifyTag

    booleano opcional

    Chrome 45 ou mais recente

    Se o sistema de arquivos é compatível com o campo tag para diretórios observados.

  • gravável

    booleano opcional

    Se o sistema de arquivos oferece suporte a operações que podem mudar o conteúdo dele (como criar, excluir ou gravar em arquivos).

MoveEntryRequestedOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • requestId

    número

    O identificador exclusivo desta solicitação.

  • sourcePath

    string

    O caminho de origem da entrada a ser movida para um novo local.

  • targetPath

    string

    O caminho de destino para a operação de cópia.

NotifyOptions

Propriedades

  • changeType

    O tipo de mudança que ocorreu na entrada observada. Se for "DELETED", a entrada observada será removida automaticamente da lista.

  • muda

    Change[] optional

    Lista de mudanças nas entradas do diretório observado (incluindo a própria entrada)

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a essa mudança.

  • observedPath

    string

    O caminho da entrada observada.

  • recursive

    booleano

    Modo da entrada observada.

  • tag

    string opcional

    Tag da notificação. Obrigatório se o sistema de arquivos foi montado com a opção supportsNotifyTag. Essa flag é necessária para fornecer notificações sobre mudanças que ocorreram mesmo quando o sistema estava desligado.

OpenedFile

Propriedades

  • filePath

    string

    O caminho do arquivo aberto.

  • Se o arquivo foi aberto para leitura ou gravação.

  • openRequestId

    número

    Um ID de solicitação a ser usado por solicitações consecutivas de leitura/gravação e fechamento.

OpenFileMode

Modo de abertura de um arquivo. Usado por onOpenFileRequested.

Enumeração

"LER"

"WRITE"

OpenFileRequestedOptions

Propriedades

  • filePath

    string

    O caminho do arquivo a ser aberto.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • Se o arquivo será usado para leitura ou gravação.

  • requestId

    número

    Um ID de solicitação que será usado por solicitações consecutivas de leitura/gravação e fechamento.

ProviderError

Códigos de erro usados por provedores de extensões em resposta a solicitações e em caso de erros ao chamar métodos da API. Para ter sucesso, use "OK".

Enumeração

"OK"

"FAILED"

"IN_USE"

"EXISTS"

"NOT_FOUND"

"ACCESS_DENIED"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NO_SPACE"

"NOT_A_DIRECTORY"

"INVALID_OPERATION"

"SECURITY"

"ABORT"

"NOT_A_FILE"

"NOT_EMPTY"

"INVALID_URL"

"IO"

ReadDirectoryRequestedOptions

Propriedades

  • directoryPath

    string

    O caminho do diretório cujo conteúdo é solicitado.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • isDirectory

    booleano

    Chrome 49+

    Defina como true se o valor is_directory for solicitado.

  • mimeType

    booleano

    Chrome 49+

    Defina como true se o valor mimeType for solicitado.

  • modificationTime

    booleano

    Chrome 49+

    Defina como true se o valor modificationTime for solicitado.

  • nome

    booleano

    Chrome 49+

    Defina como true se o valor name for solicitado.

  • requestId

    número

    O identificador exclusivo desta solicitação.

  • tamanho

    booleano

    Chrome 49+

    Defina como true se o valor size for solicitado.

  • miniatura

    booleano

    Chrome 49+

    Defina como true se o valor thumbnail for solicitado.

ReadFileRequestedOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • comprimento

    número

    Número de bytes a serem retornados.

  • offset

    número

    Posição no arquivo (em bytes) para começar a leitura.

  • openRequestId

    número

    Um ID de solicitação usado para abrir o arquivo.

  • requestId

    número

    O identificador exclusivo desta solicitação.

RemoveWatcherRequestedOptions

Propriedades

  • entryPath

    string

    O caminho da entrada monitorada.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • recursive

    booleano

    Modo do inspetor.

  • requestId

    número

    O identificador exclusivo desta solicitação.

TruncateRequestedOptions

Propriedades

  • filePath

    string

    O caminho do arquivo a ser truncado.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • comprimento

    número

    Número de bytes a serem retidos após a conclusão da operação.

  • requestId

    número

    O identificador exclusivo desta solicitação.

UnmountOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos a ser desmontado.

UnmountRequestedOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos a ser desmontado.

  • requestId

    número

    O identificador exclusivo desta solicitação.

Watcher

Propriedades

  • entryPath

    string

    O caminho da entrada que está sendo observada.

  • lastTag

    string opcional

    Tag usada pela última notificação do observador.

  • recursive

    booleano

    Se a ação de assistir deve incluir todas as entradas filhas de forma recursiva. Ele só pode ser verdadeiro para diretórios.

WriteFileRequestedOptions

Propriedades

  • dados

    ArrayBuffer

    Buffer de bytes a serem gravados no arquivo.

  • fileSystemId

    string

    O identificador do sistema de arquivos relacionado a esta operação.

  • offset

    número

    Posição no arquivo (em bytes) para começar a gravar os bytes.

  • openRequestId

    número

    Um ID de solicitação usado para abrir o arquivo.

  • requestId

    número

    O identificador exclusivo desta solicitação.

Métodos

get()

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

Retorna informações sobre um sistema de arquivos com o fileSystemId transmitido.

Parâmetros

  • fileSystemId

    string

  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    (fileSystem: FileSystemInfo) => void

Retorna

  • Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getAll()

Promise
chrome.fileSystemProvider.getAll(
  callback?: function,
)
: Promise<FileSystemInfo[]>

Retorna todos os sistemas de arquivos montados pela extensão.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    (fileSystems: FileSystemInfo[]) => void

Retorna

  • Promise<FileSystemInfo[]>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

mount()

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

Monta um sistema de arquivos com o fileSystemId e o displayName especificados. displayName vai aparecer no painel esquerdo do app Arquivos. displayName pode conter qualquer caractere, incluindo "/", mas não pode ser uma string vazia. displayName precisa ser descritivo, mas não precisa ser único. O fileSystemId não pode ser uma string vazia.

Dependendo do tipo de sistema de arquivos que está sendo montado, a opção source precisa ser definida corretamente.

Em caso de erro, runtime.lastError será definido com um código de erro correspondente.

Parâmetros

  • opções
  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    () => void

Retorna

  • Promise<void>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

notify()

Promise Chrome 45 ou mais recente
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
  callback?: function,
)
: Promise<void>

Notifica sobre mudanças no diretório monitorado em observedPath no modo recursive. Se o sistema de arquivos for montado com supportsNotifyTag, tag precisará ser fornecido, e todas as mudanças desde a última notificação serão sempre informadas, mesmo que o sistema tenha sido desligado. A última tag pode ser obtida com getAll.

Para usar, a opção de manifesto file_system_provider.notify precisa ser definida como "true".

O valor de tag pode ser qualquer string exclusiva por chamada. Assim, é possível identificar a última notificação registrada. Por exemplo, se a extensão fornecedora for iniciada após uma reinicialização e a tag da última notificação registrada for igual a "123", ela vai chamar notify para todas as mudanças que ocorreram desde a mudança marcada como "123". Não pode ser uma string vazia.

Nem todos os provedores podem fornecer uma tag, mas se o sistema de arquivos tiver um changelog, a tag poderá ser, por exemplo, um número de mudança ou um número de revisão.

Se um diretório principal for removido, todas as entradas descendentes também serão removidas. Se elas estiverem sendo monitoradas, a API precisará ser notificada sobre isso. Além disso, se um diretório for renomeado, todas as entradas descendentes serão removidas, já que não haverá mais entradas nos caminhos originais.

Em caso de erro, runtime.lastError será definido com um código de erro correspondente.

Parâmetros

  • opções
  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    () => void

Retorna

  • Promise<void>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

unmount()

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

Desativa um sistema de arquivos com o fileSystemId especificado. Ele precisa ser chamado depois que onUnmountRequested é invocado. Além disso, a extensão fornecedora pode decidir realizar a desmontagem se não for solicitada (por exemplo, em caso de perda de conexão ou erro de arquivo).

Em caso de erro, runtime.lastError será definido com um código de erro correspondente.

Parâmetros

  • opções
  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    () => void

Retorna

  • Promise<void>

    Chrome 96+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onAbortRequested

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

Gerado quando é solicitado o cancelamento de uma operação com operationRequestId. A operação executada com operationRequestId precisa ser interrompida imediatamente, e o successCallback dessa solicitação de interrupção precisa ser executado. Se a interrupção falhar, errorCallback precisará ser chamado. Callbacks da operação cancelada não devem ser chamados, porque serão ignorados. Apesar de chamar errorCallback, a solicitação pode ser interrompida à força.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

    • successCallback

      função

      O parâmetro successCallback tem esta aparência:

      () => void

    • errorCallback

      função

      O parâmetro errorCallback tem esta aparência:

      (error: ProviderError) => void

onAddWatcherRequested

Chrome 45 ou mais recente
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Gerado quando uma solicitação para definir um novo observador de diretório é feita. Se ocorrer um erro, errorCallback precisará ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onCloseFileRequested

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

Gerado quando é solicitado o fechamento de um arquivo aberto anteriormente com openRequestId.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onConfigureRequested

Chrome 44 ou mais recente
chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

Gerado quando uma caixa de diálogo de configuração para fileSystemId é solicitada. Se for processada, a opção file_system_provider.configurable do manifesto precisa ser definida como "true".

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onCopyEntryRequested

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

Gerado quando é solicitada a cópia de uma entrada (recursivamente, se for um diretório). Se ocorrer um erro, errorCallback precisará ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onCreateDirectoryRequested

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

Gerado quando é solicitada a criação de um diretório. A operação precisa falhar com o erro "EXISTS" se o diretório de destino já existir. Se recursive for verdadeiro, todos os diretórios ausentes no caminho do diretório serão criados.

Parâmetros

onCreateFileRequested

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

Gerado quando a criação de um arquivo é solicitada. Se o arquivo já existir, errorCallback precisará ser chamado com o código de erro "EXISTS".

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onDeleteEntryRequested

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

Gerado quando uma exclusão de entrada é solicitada. Se recursive for verdadeiro e a entrada for um diretório, todas as entradas dentro dele também serão excluídas de forma recursiva.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onExecuteActionRequested

Chrome 48 ou mais recente
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Gerado quando a execução de uma ação para um conjunto de arquivos ou diretórios é\ solicitada. Depois que a ação for concluída, successCallback precisará ser chamado. Em caso de erro, errorCallback precisa ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onGetActionsRequested

Chrome 48 ou mais recente
chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

Gerado quando uma lista de ações para um conjunto de arquivos ou diretórios em entryPaths é solicitada. Todas as ações retornadas precisam ser aplicáveis a cada entrada. Se não houver ações desse tipo, uma matriz vazia será retornada. As ações precisam ser retornadas com a chamada successCallback. Em caso de erro, errorCallback precisa ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onGetMetadataRequested

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

Gerado quando os metadados de um arquivo ou diretório em entryPath são solicitados. Os metadados precisam ser retornados com a chamada successCallback. Em caso de erro, errorCallback precisa ser chamado.

Parâmetros

onMountRequested

Chrome 44 ou mais recente
chrome.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

Gerado quando uma caixa de diálogo para montagem de um novo sistema de arquivos é solicitada. Se a extensão/app for um gerenciador de arquivos, esse evento não deverá ser processado. Em vez disso, app.runtime.onLaunched precisa ser processado para montar novos sistemas de arquivos quando um arquivo é aberto. Para várias montagens, a opção de manifesto file_system_provider.multiple_mounts precisa ser definida como "true".

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

    • successCallback

      função

      O parâmetro successCallback tem esta aparência:

      () => void

    • errorCallback

      função

      O parâmetro errorCallback tem esta aparência:

      (error: ProviderError) => void

onMoveEntryRequested

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

Gerado quando é solicitada a movimentação de uma entrada (recursivamente, se for um diretório). Se ocorrer um erro, errorCallback precisará ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onOpenFileRequested

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

Gerado quando é solicitada a abertura de um arquivo em filePath. Se o arquivo não existir, a operação vai falhar. O número máximo de arquivos abertos de uma só vez pode ser especificado com MountOptions.

Parâmetros

onReadDirectoryRequested

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

Gerado quando o conteúdo de um diretório em directoryPath é solicitado. Os resultados precisam ser retornados em partes chamando o successCallback várias vezes. Em caso de erro, errorCallback precisa ser chamado.

Parâmetros

onReadFileRequested

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

Gerado quando é solicitada a leitura do conteúdo de um arquivo aberto anteriormente com openRequestId. Os resultados precisam ser retornados em partes chamando successCallback várias vezes. Em caso de erro, errorCallback precisa ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

    • successCallback

      função

      O parâmetro successCallback tem esta aparência:

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

      • dados

        ArrayBuffer

      • hasMore

        booleano

    • errorCallback

      função

      O parâmetro errorCallback tem esta aparência:

      (error: ProviderError) => void

onRemoveWatcherRequested

Chrome 45 ou mais recente
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

Gerado quando o observador precisa ser removido. Se ocorrer um erro, errorCallback precisará ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onTruncateRequested

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

Gerado quando é solicitada a truncagem de um arquivo para um comprimento desejado. Se ocorrer um erro, errorCallback precisará ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onUnmountRequested

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

Gerado quando o desmontagem do sistema de arquivos com o identificador fileSystemId é solicitada. Na resposta, o método da API unmount precisa ser chamado com successCallback. Se a desmontagem não for possível (por exemplo, devido a uma operação pendente), errorCallback precisará ser chamado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

    • successCallback

      função

      O parâmetro successCallback tem esta aparência:

      () => void

    • errorCallback

      função

      O parâmetro errorCallback tem esta aparência:

      (error: ProviderError) => void

onWriteFileRequested

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

Gerado quando é solicitada a gravação de conteúdo em um arquivo aberto anteriormente com openRequestId.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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