chrome.fileSystemProvider

Descrição

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

Permissões

fileSystemProvider

Disponibilidade

Apenas no ChromeOS

É necessário declarar a permissão e a seção "fileSystemProvider" 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 da seguinte maneira:

configurable (booleano): opcional
Indica se a configuração via onConfigureRequested é compatível. Por padrão: "false".
multiple_mounts (booleano): opcional
Define se há suporte para vários sistemas de arquivos montados. Por padrão: "false".
watchable (booleano): opcional
Se é possível definir 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 da interface relacionados corretamente. Por exemplo, se configurable for definido como verdadeiro, um item de menu para configurar volumes será renderizado. Da mesma forma, se multiple_mounts estiver definido como true, o app Arquivos vai permitir que você adicione mais de um ponto de montagem da interface. Se watchable for false, um botão de atualização será renderizado. Observe que, se possível, você deve adicionar suporte para inspetores, para que as alterações no sistema de arquivos possam ser refletidas de forma imediata e automática.

Visão geral

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

Montar sistemas de arquivos.

O fornecimento de extensões pode fornecer o conteúdo do sistema de arquivos de uma fonte externa (por exemplo, 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 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 aplicativos empacotados.
"device" ou "network" onMountRequested

Como configurar sistemas de arquivos

Os sistemas de arquivos fornecidos depois de montados podem ser configurados por meio do evento onConfigureRequested. Ele é especialmente útil para sistemas de arquivos que fornecem conteúdo via rede para definir as credenciais adequadas. A manipulação deste evento é opcional.

ciclo de vida

Após a montagem, os sistemas de arquivos fornecidos são lembrados pelo Chrome e reconectados automaticamente após a reinicialização. Portanto, quando um sistema de arquivos é montado por uma extensão de fornecimento, 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

    number

    Um ID da solicitação a ser cancelada.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

Action

Chrome 45 ou mais recente

Propriedades

  • id

    string

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

  • title

    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

    boolean

    Define se a observação deve incluir todas as entradas filhas recursivamente. Pode ser verdadeira apenas para diretórios.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

Change

Propriedades

  • changeType

    ChangeType

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

  • cloudFileInfo

    CloudFileInfo opcional

    Pendente

    Informações relacionadas ao arquivo se elas forem compatíveis com um sistema de arquivos em nuvem.

  • entryPath

    string

    O caminho da entrada alterada.

ChangeType

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

Tipo enumerado

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

Pendente

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 em questão.

  • 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 recurso "SHARE" serve para compartilhar arquivos com outras pessoas. "SAVE_FOR_OFFLINE" para fixação (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.

Tipo enumerado

ConfigureRequestedOptions

Chrome 44 ou mais recente

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

    boolean

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

    Caminho da entrada a ser excluída.

  • fileSystemId

    string

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

  • recursive

    boolean

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

  • requestId

    number

    O identificador exclusivo dessa solicitação.

EntryMetadata

Propriedades

  • cloudFileInfo

    CloudFileInfo opcional

    Pendente

    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 respaldado pelo 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 o arquivo for respaldado pelo armazenamento em nuvem. Para arquivos locais sem suporte do 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 de MIME da entrada. Sempre opcional, mas deve ser fornecido se solicitado em options.

  • modificationTime

    Data opcional

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

  • name

    string opcional

    É o nome desta entrada (não o nome completo do caminho). Não pode conter "/". Para acesso raiz, 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 URI de dados nos formatos PNG, JPEG ou WEBP, com tamanho máximo de 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 usados 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

    OpenedFile[]

    Lista de arquivos abertos no momento.

  • openedFilesLimit

    number

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

  • supportsNotifyTag

    booleano opcional

    Chrome 45 ou mais recente

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

  • observadores

    Inspetor[]

    Chrome 45 ou mais recente

    Lista de observadores.

  • gravável

    boolean

    Define se o sistema de arquivos é compatível com operações que podem alterar o conteúdo do sistema de arquivos (como criação, exclusão ou gravação).

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

    number

    O identificador exclusivo dessa solicitação.

GetMetadataRequestedOptions

Propriedades

  • cloudFileInfo

    boolean

    Pendente

    Defina como true se o valor cloudFileInfo for solicitado.

  • cloudIdentifier

    boolean

    Chrome 117 ou mais recente

    Defina como true se o valor cloudIdentifier for solicitado.

  • entryPath

    string

    O caminho da entrada sobre os quais os metadados serão buscados.

  • fileSystemId

    string

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

  • isDirectory

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor is_directory for solicitado.

  • mimeType

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor mimeType for solicitado.

  • modificationTime

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor modificationTime for solicitado.

  • name

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor name for solicitado.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

  • tamanho

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor size for solicitado.

  • miniatura

    boolean

    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 vez. Se não for especificado, ou 0, então não limitado.

  • permanentes

    booleano opcional

    Chrome 64 ou mais recente

    Se o framework retomará o sistema de arquivos na próxima sessão de login. "True" por padrão.

  • supportsNotifyTag

    booleano opcional

    Chrome 45 ou mais recente

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

  • gravável

    booleano opcional

    Define se o sistema de arquivos é compatível com operações que podem alterar o conteúdo do sistema de arquivos (como criação, exclusão ou gravação).

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 para a operação de cópia.

NotifyOptions

Propriedades

  • changeType

    ChangeType

    O tipo da alteração que aconteceu com a entrada observada. Se for DELETED, a entrada observada será automaticamente removida da lista de entradas observadas.

  • Mudanças

    Alterar[] opcional

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

  • fileSystemId

    string

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

  • observedPath

    string

    O caminho da entrada observada.

  • recursive

    boolean

    Modo da entrada observada.

  • tag

    string opcional

    Tag para a notificação. Obrigatório se o sistema de arquivos tiver sido 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 abertura de um arquivo. Usado por onOpenFileRequested.

Tipo enumerado

OpenFileRequestedOptions

Propriedades

  • filePath

    string

    Caminho do arquivo a ser aberto.

  • fileSystemId

    string

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

  • Define 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 ao fornecer extensões em resposta a solicitações, bem como no caso de erros ao chamar métodos da API. Para sucesso, é preciso usar "OK".

Tipo enumerado

"OK"

"IN_USE"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NOT_A_DIRECTORY"

"INVALID_OPERATION"

"ABORT"

"NOT_A_FILE"

"NOT_EMPTY"

"INVALID_URL"

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

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor is_directory for solicitado.

  • mimeType

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor mimeType for solicitado.

  • modificationTime

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor modificationTime for solicitado.

  • name

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor name for solicitado.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

  • tamanho

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor size for solicitado.

  • miniatura

    boolean

    Chrome 49 ou mais recente

    Defina como true se o valor thumbnail for solicitado.

ReadFileRequestedOptions

Propriedades

  • fileSystemId

    string

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

  • length

    number

    Número de bytes a serem retornados.

  • offset

    number

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

  • 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

    boolean

    Modo do inspetor.

  • requestId

    number

    O identificador exclusivo dessa solicitação.

TruncateRequestedOptions

Propriedades

  • filePath

    string

    Caminho do arquivo a ser truncado.

  • fileSystemId

    string

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

  • length

    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

    boolean

    Define se a observação deve incluir todas as entradas filhas recursivamente. Pode ser verdadeira apenas para diretórios.

WriteFileRequestedOptions

Propriedades

  • dados

    ArrayBuffer

    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) para começar a gravar os bytes.

  • 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 optional

    O parâmetro callback tem esta aparência: 

    (fileSystem: FileSystemInfo)=>void

Retorna

  • Promise<FileSystemInfo>

    Chrome 96 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

getAll()

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

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

Parâmetros

Retorna

  • Promise<FileSystemInfo[]>

    Chrome 96 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

mount()

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

Monta um sistema de arquivos com as fileSystemId e as displayName fornecidas. 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 de erro correspondente.

Parâmetros

  • do modelo.

    MountOptions

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 96 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

notify()

Promessa Chrome 45+ 
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 o tag, e todas as mudanças desde a última notificação sempre serão informadas, mesmo que o sistema tenha sido encerrado. A última tag pode ser extraída 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 por chamada, então é possível identificar a última notificação registrada. Por exemplo, se a extensão de fornecimento 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 tiver 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. Se forem observadas, a API precisa ser notificada sobre o fato. Além disso, se um diretório for renomeado, todas as entradas descendentes serão removidas, porque não haverá mais entrada em seus caminhos originais.

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

Parâmetros

  • do modelo.

    NotifyOptions

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 96 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

unmount()

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

Desmonta um sistema de arquivos com o fileSystemId fornecido. Ele precisa ser chamado depois que onUnmountRequested for invocado. Além disso, a extensão de fornecimento pode decidir desmontar se não for solicitado (por exemplo, em caso de perda de conexão ou um erro de arquivo).

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

Parâmetros

  • do modelo.

    UnmountOptions

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    ()=>void

Retorna

  • Promise<void>

    Chrome 96 ou mais recente

    Promessas são compatíveis com o Manifest V3 e versões mais recentes, mas callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo que é passado para o callback.

Eventos

onAbortRequested

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

Gerado ao cancelar uma operação com operationRequestId. A operação executada com operationRequestId precisa ser interrompida imediatamente e successCallback dessa solicitação de cancelamento. Se o cancelamento falhar, errorCallback precisará ser chamado. Não se deve chamar os retornos de chamada da operação cancelada, pois eles serão ignorados. Apesar de chamar 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 mais recente 
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Gerado quando a configuração de um novo inspetor de diretório é solicitada. Se ocorrer um erro, errorCallback vai 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 que um arquivo aberto anteriormente com openRequestId seja 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 mais recente 
chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

Gerado quando a exibição de uma caixa de diálogo de configuração para fileSystemId é solicitada. Se ele for processado, a opção de exibição file_system_provider.configurable 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 ao copiar uma entrada (de maneira recursiva, se um diretório) é solicitado. Se ocorrer um erro, errorCallback vai 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 a criação de um diretório é solicitada. A operação deve 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 precisarão ser 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 a exclusão de uma entrada é solicitada. Se recursive for verdadeiro e a entrada for um diretório, todas as entradas dentro 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 mais recente 
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Gerado ao executar uma ação para um conjunto de arquivos ou diretórios é solicitada. Depois que a ação for concluída, successCallback vai precisar ser chamado. Em caso de erro, é necessário chamar errorCallback.

Parâmetros

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 essas ações, uma matriz vazia deverá ser retornada. As ações precisam ser retornadas com a chamada successCallback. Em caso de erro, errorCallback precisa ser chamado.

Parâmetros

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 ao mostrar uma caixa de diálogo para montar um novo sistema de arquivos é solicitada. Se a extensão/o app for um gerenciador de arquivos, esse evento não será processado. 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 verdadeira.

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,
)

Emitido ao mover uma entrada (de maneira recursiva, se um diretório) é solicitado. Se ocorrer um erro, errorCallback vai 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 ao abrir um arquivo em filePath. Se o arquivo não existir, a operação falhará. Use MountOptions para especificar o número máximo de arquivos abertos de uma vez.

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 successCallback várias vezes. Em caso de erro, errorCallback precisa ser chamado.

Parâmetros

onReadFileRequested

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

Gerado quando a leitura do conteúdo de um arquivo aberto anteriormente com openRequestId é solicitada. 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

        boolean

    • 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 inspetor precisa ser removido. Se ocorrer um erro, errorCallback vai precisar ser chamado.

Parâmetros

onTruncateRequested

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

É gerado ao truncar um arquivo para o tamanho desejado. Se ocorrer um erro, errorCallback vai 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 a desmontagem do sistema de arquivos com o identificador fileSystemId é solicitada. Na resposta, é necessário chamar o método da API unmount com successCallback. Se não for possível desmontar (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

onWriteFileRequested

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

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

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