chrome.fileSystemProvider

Descrição

Use a API chrome.fileSystemProvider para criar sistemas de arquivos, que podem ser acessados no gerenciador de arquivos no ChromeOS.

Permissões

fileSystemProvider

Disponibilidade

Somente ChromeOS

É necessário declarar o "fileSystemProvider" e a seção no manifesto de extensões 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 assim:

configurable (booleano) — opcional
Indica se a configuração via onConfigureRequested é compatível. Por padrão: "false".
multiple_mounts (booleano) — opcional
Define se vários sistemas de arquivos montados (mais de um) são compatíveis. Por padrão: "false".
watchable (booleano) — opcional
Define se é possível configurar observadores e notificar sobre mudanças. Por padrão: "false".
source (enumeração de "file", "device" ou "network"): obrigatório
Fonte de dados para sistemas de arquivos montados.

O app Files usa as informações acima para renderizar elementos de interface relacionados de forma adequada. Por exemplo, se configurable for definido como verdadeiro, um item de menu para configurar volumes será renderizado. Da mesma forma, se multiple_mounts for definido como true, o app Files vai permitir a adição de mais de um ponto de montagem pela interface. Se watchable for false, um botão de atualização será renderizado. Se possível, adicione suporte a observadores para que as alterações no sistema de arquivos sejam refletidas de modo imediato e automático.

Visão geral

A API File System Provider permite que 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 a descompactação de arquivos e o acesso a eles em um serviço de nuvem diferente do Drive.

Montar sistemas de arquivos.

Fornecer extensões pode fornecer conteúdo do sistema de arquivos de uma fonte externa (como um servidor remoto ou um dispositivo USB) ou usar um arquivo local (por exemplo, um arquivo) como entrada.

Para gravar sistemas de arquivos que são gerenciadores (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 deverá ser montado quando o evento onMountRequested for chamado.

Origem dos dados do sistema de arquivos Ponto de entrada
"file" Disponível somente para aplicativos em pacotes.
"device" ou "network" onMountRequested

Configurar sistemas de arquivos

Depois de montados, os sistemas de arquivos fornecidos podem ser configurados por meio do evento onConfigureRequested. Ele é especialmente útil para sistemas de arquivos que fornecem conteúdo por rede para definir credenciais adequadas. A manipulação desse evento é opcional.

Ciclo de vida

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

Tipos

AbortRequestedOptions

Propriedades

  • fileSystemId

    string

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

  • operationRequestId

    number

    Um ID da solicitação a ser cancelada.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

Action

Chrome 45 ou superior

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. Ela pode ser ignorada em ações comuns.

AddWatcherRequestedOptions

Propriedades

  • entryPath

    string

    O caminho da entrada a ser observado.

  • fileSystemId

    string

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

  • recursive

    booleano

    Define se a observação precisa incluir todas as entradas filhas de maneira recursiva. Pode ser verdadeiro apenas para diretórios.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

Change

Propriedades

  • changeType

    O tipo de alteração que ocorreu com a entrada.

  • cloudFileInfo

    CloudFileInfo opcional

    Chrome 125 ou versões mais recentes

    Informações relacionadas ao arquivo, se apoiadas por um sistema de arquivos em nuvem.

  • entryPath

    string

    Caminho da entrada alterada.

ChangeType

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

Enumeração

"ALTERADO"

"EXCLUÍDO"

CloseFileRequestedOptions

Propriedades

  • fileSystemId

    string

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

  • openRequestId

    number

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

  • requestId

    number

    O identificador exclusivo dessa solicitação.

CloudFileInfo

Chrome 125 ou versões mais recentes

Propriedades

  • versionTag

    string opcional

    Uma tag que representa a versão do arquivo.

CloudIdentifier

Chrome 117 ou versões mais recentes

Propriedades

  • id

    string

    O identificador do provedor para o arquivo/diretório em questão.

  • providerName

    string

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

CommonActionId

Chrome 45 ou superior

Lista de ações comuns. O "SHARE" serve para compartilhar arquivos com outras pessoas. "SAVE_FOR_OFFLINE" para fixação (salvando para acesso off-line). "OFFLINE_NOT_NECESSARY" por 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 superior

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos a ser configurado.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

CopyEntryRequestedOptions

Propriedades

  • fileSystemId

    string

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

  • requestId

    number

    O identificador exclusivo dessa solicitação.

  • sourcePath

    string

    O caminho de origem da entrada a ser copiada.

  • targetPath

    string

    O caminho de destino da 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

    number

    O identificador exclusivo dessa solicitação.

CreateFileRequestedOptions

Propriedades

  • filePath

    string

    O caminho do arquivo que será criado.

  • fileSystemId

    string

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

  • requestId

    number

    O identificador exclusivo dessa 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

    number

    O identificador exclusivo dessa solicitação.

EntryMetadata

Propriedades

  • cloudFileInfo

    CloudFileInfo opcional

    Chrome 125 ou versões mais recentes

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

  • cloudIdentifier

    CloudIdentifier opcional

    Chrome 117 ou versões mais recentes

    Representação do Cloud Storage dessa entrada. Precisa ser fornecido se solicitado em options e o arquivo for protegido pelo armazenamento em nuvem. Para arquivos locais não protegidos por armazenamento em nuvem, ele deve 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 para a entrada. Sempre opcional, mas precisa ser fornecido se solicitado em options.

  • modificationTime

    Data opcional

    O horário 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 o root, ele precisa estar vazio. Precisa ser fornecido se solicitado em options.

  • tamanho

    número opcional

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

  • miniatura

    string opcional

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

ExecuteActionRequestedOptions

Chrome 45 ou superior

Propriedades

  • actionId

    string

    O identificador da ação a ser executada.

  • entryPaths

    string[]

    Chrome 47 ou superior

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

  • fileSystemId

    string

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

  • requestId

    number

    O identificador exclusivo dessa 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

    number

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

  • supportsNotifyTag

    booleano opcional

    Chrome 45 ou superior

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

  • vigias
    Chrome 45 ou superior

    Lista de observadores.

  • gravável

    booleano

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

GetActionsRequestedOptions

Chrome 45 ou superior

Propriedades

  • entryPaths

    string[]

    Chrome 47 ou superior

    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

    number

    O identificador exclusivo dessa solicitação.

GetMetadataRequestedOptions

Propriedades

  • cloudFileInfo

    booleano

    Chrome 125 ou versões mais recentes

    Defina como true se o valor cloudFileInfo for solicitado.

  • cloudIdentifier

    booleano

    Chrome 117 ou versões mais recentes

    Defina como true se o valor cloudIdentifier for solicitado.

  • entryPath

    string

    O caminho da entrada sobre a qual buscar metadados.

  • fileSystemId

    string

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

  • isDirectory

    booleano

    Chrome 49 ou superior

    Defina como true se o valor is_directory for solicitado.

  • mimeType

    booleano

    Chrome 49 ou superior

    Defina como true se o valor mimeType for solicitado.

  • modificationTime

    booleano

    Chrome 49 ou superior

    Defina como true se o valor modificationTime for solicitado.

  • nome

    booleano

    Chrome 49 ou superior

    Defina como true se o valor name for solicitado.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

  • tamanho

    booleano

    Chrome 49 ou superior

    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

    número opcional

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

  • persistente

    booleano opcional

    Chrome 64 ou superior

    Define se o framework deve retomar o sistema de arquivos na próxima sessão de login. "True" por padrão.

  • supportsNotifyTag

    booleano opcional

    Chrome 45 ou superior

    Se o sistema de arquivos oferece suporte ao campo tag para diretórios observados.

  • gravável

    booleano opcional

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

MoveEntryRequestedOptions

Propriedades

  • fileSystemId

    string

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

  • requestId

    number

    O identificador exclusivo dessa solicitação.

  • sourcePath

    string

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

  • targetPath

    string

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

NotifyOptions

Propriedades

  • changeType

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

  • muda

    Mudança[] opcional

    Lista de alterações em entradas no 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

    Marque a notificação. Obrigatório se o sistema de arquivos foi montado com a opção supportsNotifyTag. Essa sinalização é necessária para fornecer notificações sobre alterações que foram alteradas mesmo quando o sistema foi desligado.

OpenedFile

Propriedades

  • filePath

    string

    Caminho do arquivo aberto.

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

  • openRequestId

    number

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

OpenFileMode

Modo de abrir um arquivo. Usado por onOpenFileRequested.

Enumeração

"LER"

"GRAVAÇÃO"

OpenFileRequestedOptions

Propriedades

  • filePath

    string

    O caminho do arquivo que 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

    number

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

ProviderError

Códigos de erro usados pelo fornecimento de extensões em resposta a solicitações, bem como em caso de erros ao chamar métodos da API. Para que o processo seja bem-sucedido, "OK" precisa ser usado.

Enumeração

"OK"

"FALHA"

"IN_USE"

"EXISTS"

"NOT_FOUND"

"ACCESS_DENIED"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NO_SPACE"

"NOT_A_DIRECTORY"

"INVALID_OPERATION"

"SEGURANÇA"

"ABORT"

"NOT_A_FILE"

"NOT_EMPTY"

"INVALID_URL"

"E/S"

ReadDirectoryRequestedOptions

Propriedades

  • directoryPath

    string

    O caminho do diretório com o conteúdo solicitado.

  • fileSystemId

    string

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

  • isDirectory

    booleano

    Chrome 49 ou superior

    Defina como true se o valor is_directory for solicitado.

  • mimeType

    booleano

    Chrome 49 ou superior

    Defina como true se o valor mimeType for solicitado.

  • modificationTime

    booleano

    Chrome 49 ou superior

    Defina como true se o valor modificationTime for solicitado.

  • nome

    booleano

    Chrome 49 ou superior

    Defina como true se o valor name for solicitado.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

  • tamanho

    booleano

    Chrome 49 ou superior

    Defina como true se o valor size for solicitado.

  • miniatura

    booleano

    Chrome 49 ou superior

    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

    number

    Número de bytes a serem retornados.

  • offset

    number

    Posição no arquivo (em bytes) em que a leitura será iniciada.

  • openRequestId

    number

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

  • requestId

    number

    O identificador exclusivo dessa 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

    number

    O identificador exclusivo dessa 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

    number

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

  • requestId

    number

    O identificador exclusivo dessa solicitação.

UnmountOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos a ser desconectado.

UnmountRequestedOptions

Propriedades

  • fileSystemId

    string

    O identificador do sistema de arquivos a ser desconectado.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

Watcher

Propriedades

  • entryPath

    string

    O caminho da entrada que está sendo observada.

  • lastTag

    string opcional

    Tag usada pela última notificação para o inspetor.

  • recursive

    booleano

    Define se a observação precisa incluir todas as entradas filhas de maneira recursiva. Pode ser verdadeiro apenas para diretórios.

WriteFileRequestedOptions

Propriedades

  • dados

    Buffer de matriz

    Buffer de bytes a ser gravado no arquivo.

  • fileSystemId

    string

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

  • offset

    number

    Posição no arquivo (em bytes) em que os bytes serão iniciados.

  • openRequestId

    number

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

  • requestId

    number

    O identificador exclusivo dessa solicitação.

Métodos

get()

Promessa
chrome.fileSystemProvider.get(
  fileSystemId: string,
  callback?: function,
)

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

  • Promise<FileSystemInfo>

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

getAll()

Promessa
chrome.fileSystemProvider.getAll(
  callback?: function,
)

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 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

mount()

Promessa
chrome.fileSystemProvider.mount(
  options: MountOptions,
  callback?: function,
)

Monta um sistema de arquivos com o fileSystemId e o displayName fornecidos. displayName será mostrado 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 exclusivo. 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 correspondente.

Parâmetros

  • opções
  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    () => void

Retorna

  • Promessa<void>

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

notify()

Promessa Chrome 45 ou superior
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
  callback?: function,
)

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

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

O valor de tag pode ser qualquer string exclusiva a cada chamada. Por isso, é possível identificar a última notificação registrada. Por exemplo: se a extensão fornecida começar após uma reinicialização e a tag da última notificação registrada for igual a "123", ela precisará chamar notify para todas as mudanças que ocorreram desde a mudança marcada como "123". Ele não pode ser uma string vazia.

Nem todos os provedores podem fornecer uma tag, mas se o sistema de arquivos tem um log de mudanças, a tag pode ser, por exemplo, . um número de alteração ou de revisão.

Observe que, se um diretório pai for removido, todas as entradas descendentes também serão removidas e, se forem observadas, a API precisará ser notificada sobre o fato. 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

  • Promessa<void>

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

unmount()

Promessa
chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
  callback?: function,
)

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

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

Parâmetros

  • opções
  • callback

    função opcional

    O parâmetro callback tem esta aparência:

    () => void

Retorna

  • Promessa<void>

    Chrome 96 ou versão mais recente

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

Eventos

onAbortRequested

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

Gerado durante 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 cancelamento precisa ser executado. Se o cancelamento falhar, será necessário chamar errorCallback. Observe que os retornos de chamada da operação cancelada não devem ser chamados, pois serão ignorados. Mesmo chamando errorCallback, a solicitação pode ser cancelada à 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 superior
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Gerado durante a configuração de um novo inspetor do diretório. Se ocorrer um erro, será necessário chamar errorCallback.

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 um arquivo aberto anteriormente com openRequestId é solicitado para ser fechado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onConfigureRequested

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

Gerado durante a exibição de uma caixa de diálogo de configuração para fileSystemId. Se ele for processado, a opção file_system_provider.configurable do mais alto padrão precisará ser definida como verdadeira.

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 durante a cópia de uma entrada (recursivamente se um diretório) é solicitada. Se ocorrer um erro, será necessário chamar errorCallback.

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 a criação de um diretório é solicitada. A operação falhará com o erro EXISTS se o diretório de destino já existir. Se recursive for verdadeiro, todos os diretórios ausentes no caminho precisarão ser criados.

Parâmetros

onCreateFileRequested

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

Gerado durante a criação de um arquivo. Se o arquivo já existir, será necessário chamar errorCallback 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 a exclusão de uma entrada é solicitada. Se recursive for verdadeiro e a entrada for um diretório, todas as entradas dele também precisarão ser excluídas recursivamente.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência:

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

onExecuteActionRequested

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

Gerado durante a execução de uma ação para um conjunto de arquivos ou diretórios. Após a conclusão da ação, successCallback precisa 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 superior
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 essas ações, uma matriz vazia deverá ser retornada. As ações precisam ser retornadas com a chamada successCallback. Em caso de erro, é necessário chamar errorCallback.

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, é necessário chamar errorCallback.

Parâmetros

onMountRequested

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

Gerado durante a exibição de uma caixa de diálogo para montar um novo sistema de arquivos. Se a extensão/aplicativo for um gerenciador de arquivos, esse evento não deverá ser tratado. Em vez disso, app.runtime.onLaunched precisa ser processado para montar novos sistemas de arquivos quando um arquivo for 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 durante a movimentação de uma entrada (recursivamente se um diretório) for solicitada. Se ocorrer um erro, será necessário chamar errorCallback.

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 ao abrir um arquivo em filePath. Se o arquivo não existir, a operação terá que 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, é necessário chamar errorCallback.

Parâmetros

onReadFileRequested

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

Gerado durante a leitura de conteúdo de um arquivo aberto anteriormente com openRequestId. Os resultados precisam ser retornados em blocos chamando successCallback várias vezes. Em caso de erro, é necessário chamar errorCallback.

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

        Buffer de matriz

      • hasMore

        booleano

    • errorCallback

      função

      O parâmetro errorCallback tem esta aparência:

      (error: ProviderError) => void

onRemoveWatcherRequested

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

Gerado quando o inspetor precisa ser removido. Se ocorrer um erro, será necessário chamar errorCallback.

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 durante uma solicitação de truncamento de um arquivo para um tamanho desejado. Se ocorrer um erro, será necessário chamar errorCallback.

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 durante a desmontagem do sistema de arquivos com o identificador fileSystemId. Na resposta, o método da API unmount precisa ser chamado com successCallback. Se não for possível desmontar (por exemplo, devido a uma operação pendente), será necessário chamar errorCallback.

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 durante 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