browser.fileSystemProvider

Opis

Używaj interfejsu API chrome.fileSystemProvider do tworzenia systemów plików, które będą dostępne w menedżerze plików w Chrome OS.

Uprawnienia

fileSystemProvider

Dostępność

Tylko w systemie ChromeOS

Aby korzystać z interfejsu File System Provider API, musisz zadeklarować uprawnienie i sekcję „fileSystemProvider” w pliku manifestu rozszerzenia. Na przykład:

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

Sekcja file_system_provider musi być zadeklarowana w ten sposób:

configurable (wartość logiczna) – opcjonalny
Określa, czy obsługiwana jest konfiguracja za pomocą onConfigureRequested. Domyślnie: false.
multiple_mounts (wartość logiczna) – opcjonalny
Określa, czy obsługiwanych jest wiele (więcej niż 1) podłączonych systemów plików. Domyślnie: false.
watchable (wartość logiczna) – opcjonalny
Czy obsługiwane jest ustawianie obserwatorów i powiadamianie o zmianach. Domyślnie: false.
source (typ wyliczeniowy „file”, „device” lub „network”) – wymagany
Źródło danych dla podłączonych systemów plików.

Aplikacja Pliki używa powyższych informacji do prawidłowego renderowania powiązanych elementów interfejsu. Jeśli na przykład parametr configurable ma wartość „true”, zostanie wyrenderowany element menu służący do konfigurowania woluminów. Podobnie, jeśli zasada multiple_mounts jest ustawiona na true, aplikacja Pliki umożliwia dodanie więcej niż 1 punktu podłączania z poziomu interfejsu. Jeśli watchable to false, zostanie wyrenderowany przycisk odświeżania. Pamiętaj, że jeśli to możliwe, dodaj obsługę obserwatorów, aby zmiany w systemie plików były odzwierciedlane natychmiast i automatycznie.

Przegląd

Interfejs File System Provider API umożliwia rozszerzeniom obsługę wirtualnych systemów plików, które są dostępne w menedżerze plików w ChromeOS. Przykłady zastosowań obejmują dekompresowanie archiwów i uzyskiwanie dostępu do plików w usłudze w chmurze innej niż Dysk.

Podłączanie systemów plików

Rozszerzenia udostępniające mogą udostępniać zawartość systemu plików ze źródła zewnętrznego (np. serwera zdalnego lub urządzenia USB) albo używać pliku lokalnego (np. archiwum) jako danych wejściowych.

Aby można było zapisywać systemy plików, które są modułami obsługi plików (źródło to "file"), dostawca musi być aplikacją spakowaną, ponieważ zdarzenie onLaunched nie jest dostępne dla rozszerzeń.

Jeśli źródłem jest sieć lub urządzenie, system plików powinien zostać podłączony po wywołaniu zdarzenia onMountRequested.

Źródło danych systemu plików. Punkt wejścia
"file" Dostępne tylko w aplikacjach spakowanych.
"device" lub "network" onMountRequested

Konfigurowanie systemów plików

Udostępnione systemy plików po zamontowaniu można skonfigurować za pomocą zdarzenia onConfigureRequested. Jest to szczególnie przydatne w przypadku systemów plików, które udostępniają treści przez sieć, aby ustawić odpowiednie dane logowania. Obsługa tego zdarzenia jest opcjonalna.

Cykl życia

Udostępnione systemy plików po zamontowaniu są zapamiętywane przez Chrome i automatycznie ponownie montowane po ponownym uruchomieniu. Dlatego po zamontowaniu systemu plików przez rozszerzenie, które go udostępnia, pozostanie on zamontowany, dopóki rozszerzenie nie zostanie wyładowane lub nie wywoła metody unmount.

Typy

AbortRequestedOptions

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • operationRequestId

    liczba

    Identyfikator żądania, które ma zostać przerwane.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

Action

Chrome 45 lub nowsza browser.* od Chrome 148

Właściwości

  • id

    tekst

    Identyfikator działania. Dowolny ciąg znaków lub CommonActionId w przypadku typowych działań.

  • tytuł

    ciąg znaków opcjonalny

    Tytuł działania. W przypadku typowych działań może być ignorowany.

AddWatcherRequestedOptions

Właściwości

  • entryPath

    tekst

    Ścieżka wpisu, który ma być obserwowany.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • rekurencyjny

    wartość logiczna

    Określa, czy obserwowanie powinno obejmować wszystkie wpisy podrzędne rekurencyjnie. Wartość prawda może być ustawiona tylko dla katalogów.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

Change

Właściwości

  • changeType

    ChangeType

    Typ zmiany, która została wprowadzona we wpisie.

  • cloudFileInfo

    CloudFileInfo opcjonalne

    Chrome 125 lub nowsza browser.* od Chrome 148

    Informacje dotyczące pliku, jeśli jest on przechowywany w systemie plików w chmurze.

  • entryPath

    tekst

    Ścieżka zmienionego wpisu.

ChangeType

Typ zmiany wykrytej w obserwowanym katalogu.

Typ wyliczeniowy

"CHANGED"

"DELETED"

CloseFileRequestedOptions

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • openRequestId

    liczba

    Identyfikator żądania użyty do otwarcia pliku.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

CloudFileInfo

Chrome 125 lub nowsza browser.* od Chrome 148

Właściwości

  • versionTag

    ciąg znaków opcjonalny

    Tag reprezentujący wersję pliku.

CloudIdentifier

Chrome 117 lub nowsza browser.* od Chrome 148

Właściwości

  • id

    tekst

    Identyfikator dostawcy dla danego pliku lub katalogu.

  • providerName

    tekst

    Identyfikator dostawcy miejsca w chmurze (np. „drive.google.com”).

CommonActionId

Chrome 45 lub nowsza browser.* od Chrome 148

Lista typowych działań. "SHARE" służy do udostępniania plików innym osobom. "SAVE_FOR_OFFLINE" do przypinania (zapisywania do dostępu offline). "OFFLINE_NOT_NECESSARY", aby powiadomić, że plik nie musi już być przechowywany do dostępu offline. Używane przez onGetActionsRequested i onExecuteActionRequested.

Typ wyliczeniowy

"SAVE_FOR_OFFLINE"

"OFFLINE_NOT_NECESSARY"

„UDOSTĘPNIJ”

ConfigureRequestedOptions

Chrome 44 lub nowsza browser.* od Chrome 148

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików, który ma zostać skonfigurowany.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

CopyEntryRequestedOptions

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

  • sourcePath

    tekst

    Ścieżka źródłowa wpisu do skopiowania.

  • targetPath

    tekst

    Ścieżka docelowa operacji kopiowania.

CreateDirectoryRequestedOptions

Właściwości

  • directoryPath

    tekst

    Ścieżka katalogu do utworzenia.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • rekurencyjny

    wartość logiczna

    Określa, czy operacja jest rekurencyjna (tylko w przypadku katalogów).

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

CreateFileRequestedOptions

Właściwości

  • filePath

    tekst

    Ścieżka pliku, który ma zostać utworzony.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

DeleteEntryRequestedOptions

Właściwości

  • entryPath

    tekst

    Ścieżka wpisu do usunięcia.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • rekurencyjny

    wartość logiczna

    Określa, czy operacja jest rekurencyjna (tylko w przypadku katalogów).

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

EntryMetadata

Właściwości

  • cloudFileInfo

    CloudFileInfo opcjonalne

    Chrome 125 lub nowsza browser.* od Chrome 148

    Informacje, które identyfikują konkretny plik w bazowym systemie plików w chmurze. Należy podać, jeśli jest to wymagane w options, a plik jest przechowywany w miejscu w chmurze.

  • cloudIdentifier

    CloudIdentifier opcjonalne

    Chrome 117 lub nowsza browser.* od Chrome 148

    Reprezentacja tego wpisu w Cloud Storage. Należy podać, jeśli jest to wymagane w options, a plik jest przechowywany w miejscu w chmurze. W przypadku plików lokalnych, które nie są objęte miejscem w chmurze, powinna być niezdefiniowana, gdy zostanie wywołana.

  • isDirectory

    boolean opcjonalne

    Wartość True (Prawda), jeśli jest to katalog. Należy podać, jeśli jest wymagany w options.

  • mimeType

    ciąg znaków opcjonalny

    Typ MIME wpisu. Zawsze opcjonalne, ale należy je podać, jeśli jest wymagane w options.

  • modificationTime

    Data opcjonalnie

    Czas ostatniej modyfikacji tego wpisu. Należy podać, jeśli jest wymagany w options.

  • nazwa

    ciąg znaków opcjonalny

    Nazwa tego wpisu (nie pełna ścieżka). Nie może zawierać znaku „/”. W przypadku katalogu głównego musi być puste. Należy podać, jeśli jest wymagany w options.

  • rozmiar

    number optional

    Rozmiar pliku w bajtach. Należy podać, jeśli jest wymagany w options.

  • miniatura

    ciąg znaków opcjonalny

    Obraz miniatury jako identyfikator URI danych w formacie PNG, JPEG lub WEBP o rozmiarze nieprzekraczającym 32 KB. Opcjonalny, ale można go podać tylko wtedy, gdy jest to wyraźnie wymagane przez zdarzenie onGetMetadataRequested.

ExecuteActionRequestedOptions

Chrome 45 lub nowsza browser.* od Chrome 148

Właściwości

  • actionId

    tekst

    Identyfikator działania, które ma zostać wykonane.

  • entryPaths

    string[]

    Chrome 47 lub nowsza browser.* od Chrome 148

    Zbiór ścieżek wpisów, które mają być używane na potrzeby działania.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

FileSystemInfo

Właściwości

  • wyświetlanaNazwa

    tekst

    Zrozumiała dla człowieka nazwa systemu plików.

  • fileSystemId

    tekst

    Identyfikator systemu plików.

  • openedFiles

    OpenedFile[]

    Lista aktualnie otwartych plików.

  • openedFilesLimit

    liczba

    Maksymalna liczba plików, które można otworzyć jednocześnie. Jeśli wartość wynosi 0, nie ma limitu.

  • supportsNotifyTag

    boolean opcjonalne

    Chrome 45 lub nowsza browser.* od Chrome 148

    Czy system plików obsługuje pole tag do obserwowania katalogów.

  • obserwatorzy

    Watcher[]

    Chrome 45 lub nowsza browser.* od Chrome 148

    Lista obserwatorów.

  • z możliwością zapisu

    wartość logiczna

    Określa, czy system plików obsługuje operacje, które mogą zmieniać jego zawartość (takie jak tworzenie, usuwanie lub zapisywanie plików).

GetActionsRequestedOptions

Chrome 45 lub nowsza browser.* od Chrome 148

Właściwości

  • entryPaths

    string[]

    Chrome 47 lub nowsza browser.* od Chrome 148

    Lista ścieżek wpisów dla listy działań.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

GetMetadataRequestedOptions

Właściwości

  • cloudFileInfo

    wartość logiczna

    Chrome 125 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość cloudFileInfo.

  • cloudIdentifier

    wartość logiczna

    Chrome 117 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość cloudIdentifier.

  • entryPath

    tekst

    Ścieżka wpisu, którego metadane chcesz pobrać.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • isDirectory

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość is_directory.

  • mimeType

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość mimeType.

  • modificationTime

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość modificationTime.

  • nazwa

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość name.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

  • rozmiar

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość size.

  • miniatura

    wartość logiczna

    Ustaw na true, jeśli wymagana jest wartość thumbnail.

MountOptions

Właściwości

  • wyświetlanaNazwa

    tekst

    Zrozumiała dla człowieka nazwa systemu plików.

  • fileSystemId

    tekst

    Identyfikator ciągu tekstowego systemu plików. Musi być unikalny dla każdego rozszerzenia.

  • openedFilesLimit

    number optional

    Maksymalna liczba plików, które można otworzyć jednocześnie. Jeśli nie zostanie podana lub będzie wynosić 0, nie będzie limitu.

  • trwałe

    boolean opcjonalne

    Chrome 64 lub nowsza browser.* od Chrome 148

    Określa, czy platforma powinna wznowić system plików podczas następnej sesji logowania. Domyślnie ma wartość True.

  • supportsNotifyTag

    boolean opcjonalne

    Chrome 45 lub nowsza browser.* od Chrome 148

    Określa, czy system plików obsługuje pole tag w przypadku obserwowanych katalogów.

  • z możliwością zapisu

    boolean opcjonalne

    Określa, czy system plików obsługuje operacje, które mogą zmieniać jego zawartość (takie jak tworzenie, usuwanie lub zapisywanie plików).

MoveEntryRequestedOptions

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

  • sourcePath

    tekst

    Ścieżka źródłowa wpisu, który ma zostać przeniesiony do nowego miejsca.

  • targetPath

    tekst

    Ścieżka docelowa operacji kopiowania.

NotifyOptions

Właściwości

  • changeType

    ChangeType

    Typ zmiany, która wystąpiła w obserwowanym wpisie. Jeśli zostanie USUNIĘTY, obserwowany wpis zostanie automatycznie usunięty z listy obserwowanych wpisów.

  • poniższych zmian

    Change[] opcjonalny

    Lista zmian wprowadzonych we wpisach w obserwowanym katalogu (w tym w samym wpisie)

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą zmianą.

  • observedPath

    tekst

    Ścieżka obserwowanego wpisu.

  • rekurencyjny

    wartość logiczna

    Tryb obserwowanego wpisu.

  • tag

    ciąg znaków opcjonalny

    Tag powiadomienia. Wymagane, jeśli system plików został podłączony z opcją supportsNotifyTag. Pamiętaj, że ta flaga jest niezbędna do otrzymywania powiadomień o zmianach, które zostały wprowadzone nawet wtedy, gdy system był wyłączony.

OpenedFile

Właściwości

  • filePath

    tekst

    Ścieżka otwartego pliku.

  • Określa, czy plik został otwarty do odczytu czy do zapisu.

  • openRequestId

    liczba

    Identyfikator żądania, który będzie używany przez kolejne żądania odczytu/zapisu i zamknięcia.

OpenFileMode

Tryb otwierania pliku. Używane przez: onOpenFileRequested.

Typ wyliczeniowy

"READ"

"WRITE"

OpenFileRequestedOptions

Właściwości

  • filePath

    tekst

    Ścieżka pliku, który ma zostać otwarty.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • Czy plik będzie używany do odczytu czy zapisu.

  • requestId

    liczba

    Identyfikator żądania, który będzie używany przez kolejne żądania odczytu/zapisu i zamknięcia.

ProviderError

Kody błędów używane przez rozszerzenia dostarczające w odpowiedzi na żądania, a także w przypadku błędów podczas wywoływania metod interfejsu API. Aby odnieść sukces, musisz użyć "OK".

Typ wyliczeniowy

„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

Właściwości

  • directoryPath

    tekst

    Ścieżka katalogu, którego zawartość jest wymagana.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • isDirectory

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość is_directory.

  • mimeType

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość mimeType.

  • modificationTime

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość modificationTime.

  • nazwa

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość name.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

  • rozmiar

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość size.

  • miniatura

    wartość logiczna

    Chrome 49 lub nowsza browser.* od Chrome 148

    Ustaw na true, jeśli wymagana jest wartość thumbnail.

ReadFileRequestedOptions

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • długość

    liczba

    Liczba bajtów do zwrócenia.

  • offset

    liczba

    Pozycja w pliku (w bajtach), od której ma się rozpocząć odczyt.

  • openRequestId

    liczba

    Identyfikator żądania użyty do otwarcia pliku.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

RemoveWatcherRequestedOptions

Właściwości

  • entryPath

    tekst

    Ścieżka obserwowanego wpisu.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • rekurencyjny

    wartość logiczna

    Tryb obserwatora.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

TruncateRequestedOptions

Właściwości

  • filePath

    tekst

    Ścieżka pliku, który ma zostać obcięty.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • długość

    liczba

    Liczba bajtów, które mają zostać zachowane po zakończeniu operacji.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

UnmountOptions

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików, który ma zostać odłączony.

UnmountRequestedOptions

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików, który ma zostać odłączony.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

Watcher

Właściwości

  • entryPath

    tekst

    Ścieżka obserwowanego wpisu.

  • lastTag

    ciąg znaków opcjonalny

    Tag używany przez ostatnie powiadomienie dla obserwatora.

  • rekurencyjny

    wartość logiczna

    Określa, czy obserwowanie powinno obejmować wszystkie wpisy podrzędne rekurencyjnie. Wartość prawda może być ustawiona tylko dla katalogów.

WriteFileRequestedOptions

Właściwości

  • dane

    ArrayBuffer

    Bufor bajtów do zapisania w pliku.

  • fileSystemId

    tekst

    Identyfikator systemu plików powiązanego z tą operacją.

  • offset

    liczba

    Pozycja w pliku (w bajtach), od której ma się rozpocząć zapisywanie bajtów.

  • openRequestId

    liczba

    Identyfikator żądania użyty do otwarcia pliku.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

Metody

get()

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

Zwraca informacje o systemie plików z przekazanym identyfikatorem fileSystemId.

Parametry

  • fileSystemId

    tekst

Zwroty

  • Promise<FileSystemInfo>

    Chrome 96 lub nowsza wersja browser.* od Chrome 148

    Wywołanie zwrotne, które otrzymuje wynik funkcji get.

getAll()

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

Zwraca wszystkie systemy plików zamontowane przez rozszerzenie.

Zwroty

  • Promise<FileSystemInfo[]>

    Chrome 96 lub nowsza wersja browser.* od Chrome 148

    Wywołanie zwrotne, które otrzymuje wynik funkcji getAll.

mount()

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

Podłącza system plików z podanymi parametrami fileSystemId i displayName. displayName będzie widoczna w lewym panelu aplikacji Pliki. displayName może zawierać dowolne znaki, w tym „/”, ale nie może być pustym ciągiem znaków. displayName musi być opisowa, ale nie musi być unikalna. fileSystemId nie może być pustym ciągiem znaków.

W zależności od typu montowanego systemu plików opcja source musi być odpowiednio ustawiona.

W przypadku błędu w polu runtime.lastError zostanie ustawiony odpowiedni kod błędu.

Parametry

Zwroty

  • thought Promise<void>

    Chrome 96 lub nowsza wersja browser.* od Chrome 148

    Ogólne wywołanie zwrotne wyniku wskazujące powodzenie lub niepowodzenie.

notify()

Chrome 45 lub nowsza browser.* od Chrome 148 
browser.fileSystemProvider.notify(
  options: NotifyOptions,
): Promise<void>

Powiadamia o zmianach w obserwowanym katalogu observedPath w trybie recursive. Jeśli system plików jest podłączony za pomocą supportsNotifyTag, należy podać tag i zawsze zgłaszać wszystkie zmiany od ostatniego powiadomienia, nawet jeśli system został wyłączony. Ostatni tag można uzyskać za pomocą getAll.

Aby można było korzystać z tej funkcji, opcja manifestu file_system_provider.notify musi mieć wartość „true”.

Wartością tag może być dowolny ciąg znaków, który jest unikalny dla każdego wywołania, dzięki czemu można zidentyfikować ostatnie zarejestrowane powiadomienie. Jeśli na przykład rozszerzenie dostarczające dane uruchamia się po ponownym uruchomieniu, a ostatnie zarejestrowane powiadomienie ma tag „123”, powinno wywołać notify w przypadku wszystkich zmian, które nastąpiły po zmianie oznaczonej tagiem „123”. Nie może być pustym ciągiem znaków.

Nie wszyscy dostawcy mogą podać tag, ale jeśli system plików ma dziennik zmian, tagiem może być np. numer zmiany lub numer wersji.

Pamiętaj, że jeśli katalog nadrzędny zostanie usunięty, wszystkie wpisy podrzędne również zostaną usunięte. Jeśli są one obserwowane, interfejs API musi zostać o tym powiadomiony. Jeśli katalog zostanie przemianowany, wszystkie wpisy podrzędne zostaną usunięte, ponieważ nie będzie już wpisu pod ich pierwotnymi ścieżkami.

W przypadku błędu runtime.lastError zostanie ustawiony odpowiedni kod błędu.

Parametry

Zwroty

  • thought Promise<void>

    Chrome 96 lub nowsza wersja browser.* od Chrome 148

    Ogólne wywołanie zwrotne wyniku wskazujące powodzenie lub niepowodzenie.

unmount()

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

Odłącza system plików o podanym identyfikatorze fileSystemId. Należy ją wywołać po wywołaniu onUnmountRequested. Rozszerzenie udostępniające może też zdecydować o odłączeniu, jeśli nie zostanie o to poproszone (np. w przypadku utraty połączenia lub błędu pliku).

W przypadku błędu w polu runtime.lastError zostanie ustawiony odpowiedni kod błędu.

Parametry

Zwroty

  • thought Promise<void>

    Chrome 96 lub nowsza wersja browser.* od Chrome 148

    Ogólne wywołanie zwrotne wyniku wskazujące powodzenie lub niepowodzenie.

Wydarzenia

onAbortRequested

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

Wywoływane, gdy żądane jest przerwanie operacji za pomocą operationRequestId. Operacja wykonywana z użyciem operationRequestId musi zostać natychmiast zatrzymana, a successCallback tego żądania przerwania musi zostać wykonane. Jeśli nie uda się przerwać, należy wywołać errorCallback. Pamiętaj, że nie wolno wywoływać wywołań zwrotnych przerwanej operacji, ponieważ zostaną one zignorowane. Mimo wywołania metody errorCallback żądanie może zostać przerwane.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

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

onAddWatcherRequested

Chrome 45 lub nowsza browser.* od Chrome 148 
browser.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Wywoływane, gdy żądane jest ustawienie nowego obserwatora katalogu. Jeśli wystąpi błąd, należy wywołać errorCallback.

Parametry

onCloseFileRequested

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

Zgłaszane, gdy plik otwarty wcześniej za pomocą openRequestId ma zostać zamknięty.

Parametry

onConfigureRequested

Chrome 44 lub nowsza browser.* od Chrome 148 
browser.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

Wywoływane, gdy wymagane jest wyświetlenie okna konfiguracji dla fileSystemId. Jeśli jest obsługiwany, opcja manifestu file_system_provider.configurable musi mieć wartość „true”.

Parametry

onCopyEntryRequested

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

Zgłaszane, gdy żądane jest skopiowanie wpisu (rekurencyjnie, jeśli jest to katalog). Jeśli wystąpi błąd, należy wywołać errorCallback.

Parametry

onCreateDirectoryRequested

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

Zgłaszany, gdy żądane jest utworzenie katalogu. Jeśli katalog docelowy już istnieje, operacja musi zakończyć się błędem EXISTS. Jeśli recursive ma wartość true, należy utworzyć wszystkie brakujące katalogi w ścieżce katalogu.

Parametry

onCreateFileRequested

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

Zgłaszane, gdy żądane jest utworzenie pliku. Jeśli plik już istnieje, należy wywołać errorCallback z kodem błędu "EXISTS".

Parametry

onDeleteEntryRequested

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

Zgłaszane, gdy wymagane jest usunięcie wpisu. Jeśli parametr recursive ma wartość „true”, a wpis jest katalogiem, wszystkie wpisy w nim muszą zostać usunięte rekurencyjnie.

Parametry

onExecuteActionRequested

Chrome 48 lub nowsza browser.* od Chrome 148 
browser.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Wywoływane, gdy żądane jest wykonanie działania na zbiorze plików lub katalogów. Po zakończeniu działania należy wywołać successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

onGetActionsRequested

Chrome 48 lub nowsza browser.* od Chrome 148 
browser.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

Zgłaszane, gdy żądana jest lista działań dla zestawu plików lub katalogów w entryPaths. Wszystkie zwrócone działania muszą mieć zastosowanie do każdego wpisu. Jeśli nie ma takich działań, powinna zostać zwrócona pusta tablica. Działania muszą być zwracane za pomocą wywołania successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

onGetMetadataRequested

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

Zgłaszane, gdy żądane są metadane pliku lub katalogu w entryPath. Metadane muszą zostać zwrócone wraz z wywołaniem successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

onMountRequested

Chrome 44 lub nowsza browser.* od Chrome 148 
browser.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

Wywoływane, gdy wymagane jest wyświetlenie okna dialogowego do zamontowania nowego systemu plików. Jeśli rozszerzenie lub aplikacja jest modułem obsługi plików, to zdarzenie nie powinno być obsługiwane. Zamiast tego należy obsłużyć app.runtime.onLaunched, aby zamontować nowe systemy plików po otwarciu pliku. W przypadku wielu punktów montowania opcja manifestu file_system_provider.multiple_mounts musi mieć wartość „true”.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

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

    • successCallback

      funkcja

      Parametr successCallback wygląda tak:

      () => void

    • errorCallback

      funkcja

      Parametr errorCallback wygląda tak:

      (error: ProviderError) => void

onMoveEntryRequested

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

Wywoływane, gdy żądane jest przeniesienie wpisu (rekurencyjnie, jeśli jest to katalog). Jeśli wystąpi błąd, należy wywołać errorCallback.

Parametry

onOpenFileRequested

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

Zgłaszane, gdy wymagane jest otwarcie pliku w filePath. Jeśli plik nie istnieje, operacja musi się nie powieść. Maksymalną liczbę plików otwartych jednocześnie można określić za pomocą MountOptions.

Parametry

onReadDirectoryRequested

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

Zgłaszane, gdy żądana jest zawartość katalogu w directoryPath. Wyniki muszą być zwracane we fragmentach przez kilkukrotne wywołanie metody successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

onReadFileRequested

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

Zgłaszany, gdy żądany jest odczyt zawartości pliku otwartego wcześniej za pomocą openRequestId. Wyniki muszą być zwracane we fragmentach przez kilkukrotne wywołanie metody successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

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

    • successCallback

      funkcja

      Parametr successCallback wygląda tak:

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

      • dane

        ArrayBuffer

      • hasMore

        wartość logiczna

    • errorCallback

      funkcja

      Parametr errorCallback wygląda tak:

      (error: ProviderError) => void

onRemoveWatcherRequested

Chrome 45 lub nowsza browser.* od Chrome 148 
browser.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

Wywoływane, gdy należy usunąć obserwatora. Jeśli wystąpi błąd, należy wywołać errorCallback.

Parametry

onTruncateRequested

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

Zgłaszane, gdy wymagane jest skrócenie pliku do żądanej długości. Jeśli wystąpi błąd, należy wywołać errorCallback.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

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

onUnmountRequested

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

Wywoływane, gdy żądane jest odłączenie systemu plików o identyfikatorze fileSystemId. W odpowiedzi metoda interfejsu API unmount musi zostać wywołana razem z successCallback. Jeśli odłączenie nie jest możliwe (np. z powodu oczekującej operacji), należy wywołać metodę errorCallback.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

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

onWriteFileRequested

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

Zgłaszany, gdy żądane jest zapisanie zawartości w pliku otwartym wcześniej za pomocą openRequestId.

Parametry