chrome.fileSystemProvider

refresh date: 2026-09-25 robots: noindex

Opis

Użyj interfejsu chrome.fileSystemProvider API, aby tworzyć systemy plików, które będą dostępne w menedżerze plików w ChromeOS.

Uprawnienia

fileSystemProvider

Dostępność

Tylko ChromeOS

Plik manifestu

Aby używać interfejsu File System Provider API, musisz zadeklarować uprawnienie i sekcję „fileSystemProvider” w manifeście 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) – opcjonalnie
Określa, czy konfiguracja za pomocą onConfigureRequested jest obsługiwana. Domyślnie: fałsz.
multiple_mounts (wartość logiczna) – opcjonalnie
Czy obsługiwanych jest wiele (więcej niż 1) zamontowanych systemów plików. Domyślnie: fałsz.
watchable (wartość logiczna) – opcjonalnie
Określa, czy ustawianie obserwatorów i powiadamianie o zmianach jest obsługiwane. Domyślnie: fałsz.
source (wartość wyliczeniowa „file”, „device” lub „network”) – wymagane
Źródło danych dla zamontowanych 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 wartość parametru configurable to „true”, zostanie wyświetlony element menu do konfigurowania głośności. Podobnie jeśli zasada multiple_mounts ma wartość true, aplikacja Pliki umożliwi dodanie z poziomu interfejsu więcej niż 1 punktu montowania. Jeśli wartość watchable to false, zostanie wyświetlony przycisk odświeżania. Pamiętaj, że w miarę możliwości warto dodać 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ń to rozpakowywanie archiwów i dostęp do plików w usłudze w chmurze innej niż Dysk.

Podłączanie systemów plików

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

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

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

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

Konfigurowanie systemów plików

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

Cykl życia

Po zamontowaniu systemy plików są zapamiętywane przez Chrome i automatycznie montowane ponownie po ponownym uruchomieniu. Dlatego po zamontowaniu systemu plików przez rozszerzenie pozostanie on zamontowany, dopóki rozszerzenie nie zostanie odł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 nowszy

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

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

AddWatcherRequestedOptions

Właściwości

  • entryPath

    tekst

    Ścieżka wpisu do obserwowania.

  • fileSystemId

    tekst

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

  • rekursywny

    wartość logiczna

    Określa, czy obserwacja ma obejmować wszystkie wpisy podrzędne rekurencyjnie. Może być prawdziwa tylko w przypadku katalogów.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

Change

Właściwości

  • changeType

    ChangeType

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

  • cloudFileInfo

    CloudFileInfo [optional]

    Chrome 125 lub nowsza

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

  • entryPath

    tekst

    Ścieżka zmienionego wpisu.

ChangeType

Rodzaj 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żywany do otwierania pliku.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

CloudFileInfo

Chrome 125 lub nowsza

Właściwości

  • versionTag

    ciąg znaków opcjonalny

    Tag reprezentujący wersję pliku.

CloudIdentifier

Chrome 117 lub nowsza

Właściwości

  • id

    tekst

    Identyfikator dostawcy dla danego pliku lub katalogu.

  • providerName

    tekst

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

CommonActionId

Chrome 45 lub nowszy

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

Typ wyliczeniowy

"SAVE_FOR_OFFLINE"

„OFFLINE_NOT_NECESSARY”

„UDOSTĘPNIJ”

ConfigureRequestedOptions

Chrome 44 lub nowsza

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików do skonfigurowania.

  • 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ą.

  • rekursywny

    wartość logiczna

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

  • rekursywny

    wartość logiczna

    Czy operacja jest rekurencyjna (tylko w przypadku katalogów).

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

EntryMetadata

Właściwości

  • cloudFileInfo

    CloudFileInfo [optional]

    Chrome 125 lub nowsza

    Informacje, które identyfikują konkretny plik w bazowym systemie plików w chmurze. Musi być podana, jeśli jest wymagana w options, a plik jest przechowywany w chmurze.

  • cloudIdentifier

    CloudIdentifier opcjonalny

    Chrome 117 lub nowsza

    Reprezentacja tego wpisu w Cloud Storage. Musi być podana, jeśli jest wymagana w options, a plik jest przechowywany w chmurze. W przypadku plików lokalnych, które nie są przechowywane w chmurze, w przypadku żądania powinna być zwracana wartość undefined.

  • isDirectory

    wartość logiczna opcjonalna

    Wartość „prawda”, jeśli jest to katalog. Wymagane, jeśli jest to wymagane w options.

  • mimeType

    ciąg znaków opcjonalny

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

  • modificationTime

    Data opcjonalna

    Czas ostatniej modyfikacji tego wpisu. Musi być podany, jeśli jest wymagany w options.

  • nazwa

    ciąg znaków opcjonalny

    Nazwa tego wpisu (nie pełna nazwa ścieżki). Nie może zawierać znaku „/”. W przypadku katalogu głównego musi być puste. Wymagane, jeśli jest to wymagane w options.

  • rozmiar

    number opcjonalny

    Rozmiar pliku w bajtach. Wymagane, jeśli jest to wymagane w options.

  • miniatura

    ciąg znaków opcjonalny

    Miniatura obrazu jako identyfikator URI danych w formacie PNG, JPEG lub WEBP o rozmiarze maksymalnie 32 KB. Opcjonalny, ale można go podać tylko wtedy, gdy onGetMetadataRequested zdarzenie wyraźnie tego wymaga.

ExecuteActionRequestedOptions

Chrome 45 lub nowszy

Właściwości

  • actionId

    tekst

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

  • entryPaths

    string[]

    Chrome 47 lub nowsza

    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 ograniczeń.

  • supportsNotifyTag

    wartość logiczna opcjonalna

    Chrome 45 lub nowszy

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

  • obserwatorzy,

    Obserwator[]

    Chrome 45 lub nowszy

    Lista obserwujących.

  • z możliwością zapisu,

    wartość logiczna

    Czy system plików obsługuje operacje, które mogą zmieniać zawartość systemu plików (np. tworzenie, usuwanie lub zapisywanie plików).

GetActionsRequestedOptions

Chrome 45 lub nowszy

Właściwości

  • entryPaths

    string[]

    Chrome 47 lub nowsza

    Lista ścieżek wpisów na liście 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

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

  • cloudIdentifier

    wartość logiczna

    Chrome 117 lub nowsza

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

  • entryPath

    tekst

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

  • fileSystemId

    tekst

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

  • isDirectory

    wartość logiczna

    Chrome 49 lub nowszy

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

  • mimeType

    wartość logiczna

    Chrome 49 lub nowszy

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

  • modificationTime

    wartość logiczna

    Chrome 49 lub nowszy

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

  • nazwa

    wartość logiczna

    Chrome 49 lub nowszy

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

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

  • rozmiar

    wartość logiczna

    Chrome 49 lub nowszy

    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 w przypadku każdego rozszerzenia.

  • openedFilesLimit

    number opcjonalny

    Maksymalna liczba plików, które można otworzyć jednocześnie. Jeśli nie podasz żadnej wartości lub podasz wartość 0, limit nie będzie obowiązywać.

  • trwałe,

    wartość logiczna opcjonalna

    Chrome 64+

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

  • supportsNotifyTag

    wartość logiczna opcjonalna

    Chrome 45 lub nowszy

    Czy system plików obsługuje pole tag w przypadku obserwowanych katalogów.

  • z możliwością zapisu,

    wartość logiczna opcjonalna

    Czy system plików obsługuje operacje, które mogą zmieniać zawartość systemu plików (np. 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 w nowe miejsce.

  • targetPath

    tekst

    Ścieżka docelowa operacji kopiowania.

NotifyOptions

Właściwości

  • changeType

    ChangeType

    Rodzaj zmiany, która zaszła w obserwowanym wpisie. Jeśli jest to DELETED, obserwowany wpis zostanie automatycznie usunięty z listy obserwowanych wpisów.

  • poniższych zmian

    Change[] opcjonalny

    Lista zmian w elementach w obserwowanym katalogu (w tym w samym elemencie).

  • fileSystemId

    tekst

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

  • observedPath

    tekst

    Ścieżka obserwowanego wpisu.

  • rekursywny

    wartość logiczna

    Tryb obserwowanej pozycji.

  • tag

    ciąg znaków opcjonalny

    Tag powiadomienia. Wymagane, jeśli system plików został zamontowany z opcją supportsNotifyTag. Pamiętaj, że ta flaga jest niezbędna do wysyłania powiadomień o zmianach, które zaszły 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 zapisu.

  • openRequestId

    liczba

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

OpenFileMode

Sposób otwierania pliku. Używane przez onOpenFileRequested.

Typ wyliczeniowy

„READ”

„WRITE”

OpenFileRequestedOptions

Właściwości

  • filePath

    tekst

    Ścieżka pliku do otwarcia.

  • fileSystemId

    tekst

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

  • czy plik będzie używany do czytania czy pisania.

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

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

  • mimeType

    wartość logiczna

    Chrome 49 lub nowszy

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

  • modificationTime

    wartość logiczna

    Chrome 49 lub nowszy

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

  • nazwa

    wartość logiczna

    Chrome 49 lub nowszy

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

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

  • rozmiar

    wartość logiczna

    Chrome 49 lub nowszy

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

  • miniatura

    wartość logiczna

    Chrome 49 lub nowszy

    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.

  • odliczyć

    liczba

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

  • openRequestId

    liczba

    Identyfikator żądania używany do otwierania 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ą.

  • rekursywny

    wartość logiczna

    Tryb obserwatora.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

TruncateRequestedOptions

Właściwości

  • filePath

    tekst

    Ścieżka pliku do obcięcia.

  • 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 do odmontowania.

UnmountRequestedOptions

Właściwości

  • fileSystemId

    tekst

    Identyfikator systemu plików do odmontowania.

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

  • rekursywny

    wartość logiczna

    Określa, czy obserwowanie powinno obejmować wszystkie wpisy podrzędne rekursywnie. Może być prawdziwa tylko w przypadku 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ą.

  • odliczyć

    liczba

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

  • openRequestId

    liczba

    Identyfikator żądania używany do otwierania pliku.

  • requestId

    liczba

    Unikalny identyfikator tej prośby.

Metody

get()

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

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

Parametry

  • fileSystemId

    tekst

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    (fileSystem: FileSystemInfo) => void

Zwroty

  • Promise<FileSystemInfo>

    Chrome 96 lub nowsza

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

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

getAll()

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

Zwraca wszystkie systemy plików zamontowane przez rozszerzenie.

Parametry

Zwroty

  • Promise<FileSystemInfo[]>

    Chrome 96 lub nowsza

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

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

mount()

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

Podłącza system plików z podanymi wartościami fileSystemId i displayName. displayName będzie widoczny w panelu po lewej stronie aplikacji Pliki. displayName może zawierać dowolne znaki, w tym „/”, ale nie może być pustym ciągiem znaków. displayName musi być opisowe, ale nie musi być unikalne. Pole fileSystemId nie może być puste.

W zależności od typu montowanego systemu plików należy odpowiednio ustawić opcję source.

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

Parametry

  • Opcje

    MountOptions

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 96 lub nowsza

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

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

notify()

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

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

Aby korzystać z tej funkcji, opcja manifestu file_system_provider.notify musi mieć wartość Prawda.

Wartość tag może być dowolnym ciągiem znaków, który jest unikalny dla każdego wywołania, dzięki czemu można zidentyfikować ostatnie zarejestrowane powiadomienie. Jeśli np. rozszerzenie dostarczające zaczyna działać po ponownym uruchomieniu, a tag ostatniego zarejestrowanego powiadomienia to „123”, powinno ono wywołać funkcję notify w przypadku wszystkich zmian, które nastąpiły od zmiany oznaczonej tagiem „123”. Nie może być pustym ciągiem znaków.

Nie wszyscy dostawcy mogą udostępnić 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 usuniesz katalog nadrzędny, wszystkie wpisy podrzędne również zostaną usunięte, a jeśli są obserwowane, interfejs API musi zostać o tym powiadomiony. Jeśli zmienisz nazwę katalogu, wszystkie wpisy podrzędne zostaną usunięte, ponieważ nie będą już dostępne pod pierwotnymi ścieżkami.

W przypadku błędu wartość runtime.lastError zostanie ustawiona na odpowiedni kod błędu.

Parametry

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 96 lub nowsza

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

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

unmount()

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

Odmontowuje system plików o podanym identyfikatorze fileSystemId. Musi być wywoływana po wywołaniu funkcji onUnmountRequested. Rozszerzenie udostępniające może też zdecydować się na odmontowanie, jeśli nie zostanie o to poproszone (np. w przypadku utraty połączenia lub błędu pliku).

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

Parametry

  • callback

    funkcja opcjonalna

    Parametr callback wygląda tak:

    () => void

Zwroty

  • Promise<void>

    Chrome 96 lub nowsza

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

    Obietnice są obsługiwane tylko w przypadku platformy Manifest V3 i nowszych. Inne platformy muszą używać wywołań zwrotnych.

Wydarzenia

onAbortRequested

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

Występuje, gdy zażądano przerwania operacji za pomocą operationRequestId. Operację wykonaną za pomocą operationRequestId należy natychmiast zatrzymać i wykonać successCallback tej prośby o przerwanie. Jeśli przerwanie się nie powiedzie, należy wywołać funkcję errorCallback. Pamiętaj, że wywołania zwrotne przerwanej operacji nie mogą być wywoływane, ponieważ zostaną zignorowane. Pomimo wywołania funkcji 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 nowszy 
chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

Wywoływany, gdy zostanie wysłane żądanie ustawienia nowego obserwatora katalogu. Jeśli wystąpi błąd, należy wywołać funkcję errorCallback.

Parametry

onCloseFileRequested

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

Występuje, gdy użytkownik chce zamknąć plik otwarty wcześniej za pomocą funkcji openRequestId.

Parametry

onConfigureRequested

Chrome 44 lub nowsza 
chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

Wywoływane, gdy pojawi się prośba o wyświetlenie okna konfiguracji dla fileSystemId. Jeśli jest obsługiwany, opcja file_system_provider.configurable manifestu musi mieć wartość true.

Parametry

onCopyEntryRequested

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

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

Parametry

onCreateDirectoryRequested

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

Występuje, gdy zostanie zgłoszona prośba o utworzenie katalogu. Jeśli katalog docelowy już istnieje, operacja musi zakończyć się niepowodzeniem z błędem EXISTS. Jeśli recursive ma wartość true, należy utworzyć wszystkie brakujące katalogi na ścieżce katalogu.

Parametry

onCreateFileRequested

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

Występuje, gdy zostanie zgłoszona prośba o utworzenie pliku. Jeśli plik już istnieje, należy wywołać funkcję errorCallback z kodem błędu "EXISTS".

Parametry

onDeleteEntryRequested

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

Wywoływane, gdy zostanie przesłana prośba o usunięcie wpisu. Jeśli recursive ma wartość „true” i wpis jest katalogiem, wszystkie wpisy w nim również muszą zostać usunięte rekurencyjnie.

Parametry

onExecuteActionRequested

Chrome 48 lub nowsza 
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

Wywoływany, gdy zażądano wykonania działania w przypadku zestawu plików lub katalogów. Po wykonaniu działania należy wywołać funkcję successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

onGetActionsRequested

Chrome 48 lub nowsza 
chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

Występuje, gdy zażądana jest lista działań dla zestawu plików lub katalogów w entryPaths. Wszystkie zwrócone działania muszą być odpowiednie dla każdego wpisu. Jeśli nie ma takich działań, należy zwrócić pustą tablicę. Działania muszą być zwracane w wywołaniu successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

onGetMetadataRequested

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

Występuje, gdy zażądano metadanych pliku lub katalogu w entryPath. Metadane muszą być zwracane w wywołaniu successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

onMountRequested

Chrome 44 lub nowsza 
chrome.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

Wywoływane, gdy pojawi się prośba o wyświetlenie okna dialogowego do montowania 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ługiwać znak app.runtime.onLaunched, aby montować 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

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

Występuje, gdy zostanie zgłoszona prośba o przeniesienie wpisu (rekursywnie, jeśli jest to katalog). Jeśli wystąpi błąd, należy wywołać funkcję errorCallback.

Parametry

onOpenFileRequested

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

Występuje, gdy zażądano otwarcia 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ą parametru MountOptions.

Parametry

onReadDirectoryRequested

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

Występuje, gdy zażądano zawartości katalogu w lokalizacji directoryPath. Wyniki muszą być zwracane w częściach przez wielokrotne wywoływanie funkcji successCallback. W przypadku błędu należy wywołać funkcję errorCallback.

Parametry

onReadFileRequested

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

Występuje, gdy zażądano odczytania zawartości pliku otwartego wcześniej za pomocą funkcji openRequestId. Wyniki muszą być zwracane w częściach przez wielokrotne wywoływanie funkcji 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 nowszy 
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

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

Parametry

onTruncateRequested

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

Występuje, gdy wymagane jest obcięcie pliku do żądanej długości. Jeśli wystąpi błąd, należy wywołać funkcję errorCallback.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

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

onUnmountRequested

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

Występuje, gdy zażądano odmontowania systemu plików o identyfikatorze fileSystemId. W odpowiedzi metoda interfejsu API unmount musi być wywoływana razem z successCallback. Jeśli odmontowanie nie jest możliwe (np. z powodu oczekującej operacji), należy wywołać funkcję errorCallback.

Parametry

  • callback

    funkcja

    Parametr callback wygląda tak:

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

onWriteFileRequested

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

Występuje, gdy żądane jest zapisanie treści w pliku otwartym wcześniej za pomocą funkcji openRequestId.

Parametry