chrome.extension

Opis

Interfejs API chrome.extension zawiera narzędzia, których można używać na dowolnej stronie rozszerzenia. Obejmuje to obsługę wymiany wiadomości między rozszerzeniem a jego skryptami treści lub między rozszerzeniami, jak opisano szczegółowo w sekcji Przesyłanie wiadomości.

Typy

ViewType

Chrome 44 lub nowszy

Typ widoku rozszerzenia.

Typ wyliczeniowy

„tab”

„popup”

Właściwości

inIncognitoContext

Prawda w przypadku skryptów treści działających na kartach incognito oraz stron rozszerzeń działających w ramach procesu incognito. Ta ostatnia dotyczy tylko rozszerzeń z wartością „split” w parametrze incognito_behavior.

Typ

wartość logiczna

lastError

≤ MV2 Wycofane w Chrome 58

Użyj runtime.lastError.

Ustaw na czas trwania wywołania zwrotnego, jeśli asynchroniczne rozszerzenie interfejsu API spowodowało błąd. Jeśli nie wystąpił żaden błąd, lastError będzie miał wartość undefined.

Typ

Obiekt

Właściwości

  • wiadomość

    ciąg znaków

    Opis błędu, który wystąpił.

Metody

getBackgroundPage()

Tylko na pierwszym planie 
chrome.extension.getBackgroundPage()

Zwraca obiekt JavaScript „window” dla strony w tle działającej w bieżącym rozszerzeniu. Zwraca wartość null, jeśli rozszerzenie nie ma strony w tle.

Zwroty

  • Okno | nieokreślone

getExtensionTabs()

≤ MV2 Tylko na pierwszym planie Wycofano
chrome.extension.getExtensionTabs(
  windowId?: number,
)

Użyj extension.getViews {type: "tab"}.

Zwraca tablicę obiektów JavaScript „window” dla każdej karty uruchomionej w bieżącym rozszerzeniu. Jeśli podana jest wartość windowId, zwraca tylko obiekty „window” kart dołączonych do określonego okna.

Parametry

  • windowId

    number opcjonalny

Zwroty

  • Window[]

    Tablica globalnych obiektów okna

getURL()

≤ MV2 Wycofane w Chrome 58
chrome.extension.getURL(
  path: string,
)

Użyj runtime.getURL.

Konwertuje ścieżkę względną w katalogu instalacji rozszerzenia na pełny adres URL.

Parametry

  • ścieżka

    ciąg znaków

    Ścieżka do zasobu w rozszerzeniu wyrażona względem katalogu instalacyjnego.

Zwroty

  • ciąg znaków

    Pełny adres URL zasobu.

getViews()

Tylko na pierwszym planie 
chrome.extension.getViews(
  fetchProperties?: object,
)

Zwraca tablicę obiektów JavaScript „window” dla każdej strony działającej w bieżącym rozszerzeniu.

Parametry

  • fetchProperties

    object opcjonalne

    • tabId

      number opcjonalny

      Chrome 54 lub nowszy

      Znajdź widok według identyfikatora karty. Jeśli pominiesz to pole, zwróci wszystkie wyświetlenia.

    • typ

      ViewType opcjonalny

      Typ widoku. Jeśli pominiesz ten parametr, funkcja zwróci wszystkie widoki (w tym strony i karty w tle).

    • windowId

      number opcjonalny

      Okno, w którym ma być ograniczone wyszukiwanie. Jeśli pominiesz ten parametr, funkcja zwróci wszystkie widoki.

Zwroty

  • Window[]

    Tablica obiektów globalnych

isAllowedFileSchemeAccess()

Obietnice 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

Pobiera stan dostępu rozszerzenia do schematu „plik://”. Odpowiada ono ustawieniu „Zezwalaj na dostęp do adresów URL plików” w przypadku poszczególnych rozszerzeń, które użytkownik może kontrolować na stronie chrome://extensions.

Parametry

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      wartość logiczna

      Wartość „prawda”, jeśli rozszerzenie może uzyskać dostęp do schematu „plik://”. W przeciwnym razie ma wartość „fałsz”.

Zwroty

  • Promise<boolean>

    Chrome 99+

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

isAllowedIncognitoAccess()

Obietnice 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

Pobiera stan dostępu rozszerzenia do trybu incognito. Odpowiada ono ustawieniu „Dozwolone w trybie incognito” dla poszczególnych rozszerzeń, które użytkownik może kontrolować na stronie chrome://extensions.

Parametry

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      wartość logiczna

      Wartość „prawda”, jeśli rozszerzenie ma dostęp do trybu incognito. W przeciwnym razie ma wartość „fałsz”.

Zwroty

  • Promise<boolean>

    Chrome 99+

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

sendRequest()

Obietnice &leq; MV2 Wycofane
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

Użyj runtime.sendMessage.

Wysyła jedną prośbę do innych odbiorców w ramach rozszerzenia. Działa podobnie do żądania runtime.connect, ale wysyła tylko jedno żądanie z opcjonalną odpowiedzią. Zdarzenie extension.onRequest jest wywoływane na każdej stronie rozszerzenia.

Parametry

  • extensionId

    string opcjonalny

    Identyfikator rozszerzenia, z którym chcesz się połączyć. Jeśli nie zostanie podany, domyślnie zostanie użyte Twoje rozszerzenie.

  • żądanie

    każdy

  • wywołanie zwrotne

    function opcjonalny

    Chrome 99+

    Parametr callback ma postać:

    (response: any) => void

    • odpowiedź

      każdy

      Obiekt odpowiedzi JSON wysłany przez moduł obsługi żądania. Jeśli podczas łączenia z rozszerzeniem wystąpi błąd, wywołana zostanie funkcja wywołania zwrotnego bez argumentów, a wartość runtime.lastError zostanie ustawiona jako komunikat o błędzie.

Zwroty

  • Promise<any>

    Chrome 99+

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

Ustawia wartość parametru ap CGI używanego w adresie URL aktualizacji rozszerzenia. Ta wartość jest ignorowana w przypadku rozszerzeń hostowanych w Galerii rozszerzeń do Chrome.

Parametry

  • dane

    ciąg znaków

Wydarzenia

onRequest

&leq; MV2 Wycofane
chrome.extension.onRequest.addListener(
  callback: function,
)

Użyj runtime.onMessage.

Wywoływane, gdy żądanie jest wysyłane z procesu rozszerzenia lub skryptu treści.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback ma postać:

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • żądanie

      każdy

    • sendResponse

      funkcja

      Parametr sendResponse ma postać:

      () => void

onRequestExternal

&leq; MV2 Wycofane
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Użyj runtime.onMessageExternal.

Wywoływany, gdy prośba jest wysyłana z innego rozszerzenia.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback ma postać:

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • żądanie

      każdy

    • sendResponse

      funkcja

      Parametr sendResponse ma postać:

      () => void