chrome.extension

Opis

Interfejs chrome.extension API zawiera narzędzia, których można używać na dowolnej stronie rozszerzenia. Obejmuje ona obsługę wymiany wiadomości między rozszerzeniem a jego skryptami treści lub między rozszerzeniami. Szczegółowe informacje na ten temat znajdziesz w sekcji Przekazywanie wiadomości.

Typy

ViewType

Chrome 44 i nowsze wersje

Typ widoku rozszerzenia.

Enum

"tab"

Właściwości

inIncognitoContext

Prawda w przypadku skryptów treści działających na kartach incognito oraz na stronach rozszerzeń działających w ramach procesu incognito. To ograniczenie dotyczy tylko rozszerzeń z zachowaniem „podziału” incognito_behavior.

Typ

boolean

lastError

≤ MV2 Wycofane od Chrome 58

Użyj adresu runtime.lastError.

Ustaw wartość dla całego okresu wywołania zwrotnego, jeśli interfejs API rozszerzenia ansyronowego powoduje błąd. Jeśli nie wystąpił żaden błąd, parametr lastError ma wartość undefined.

Typ

obiekt

Właściwości

  • wiadomość

    string,

    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.

Akcje powrotne

  • 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” w przypadku każdej karty uruchomionej w bieżącym rozszerzeniu. Jeśli określono windowId, zwracane są tylko obiekty „window” kart dołączonych do określonego okna.

Parametry

  • windowId

    Liczba opcjonalnie

Akcje powrotne

  • Okno[]

    Tablica globalnych obiektów okien

getURL()

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

Użyj adresu runtime.getURL.

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

Parametry

  • ścieżka

    string,

    Ścieżka do zasobu w rozszerzeniu wyrażona w odniesieniu do jego katalogu instalacyjnego.

Akcje powrotne

  • string,

    Pełny adres URL zasobu.

getViews()

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

Zwraca tablicę obiektów JavaScript „window” w przypadku każdej strony uruchomionej w bieżącym rozszerzeniu.

Parametry

  • fetchProperties

    obiekt opcjonalnie

    • tabId

      Liczba opcjonalnie

      Chrome w wersji 54 i nowszych

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

    • typ

      ViewType opcjonalnie

      Typ widoku, który chcesz uzyskać. Jeśli zostanie pominięty, zwraca wszystkie widoki (w tym strony działające w tle i karty).

    • windowId

      Liczba opcjonalnie

      Okno, do którego chcesz ograniczyć wyszukiwanie. W przypadku pominięcia zwraca wszystkie widoki.

Akcje powrotne

  • Okno[]

    Tablica obiektów globalnych

isAllowedFileSchemeAccess()

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

Pobiera stan dostępu rozszerzenia do schematu „file://”. Odpowiada to kontrolowanemu przez użytkownika ustawieniu „Zezwalaj na dostęp do adresów URL plików” dostępnego na stronie chrome://extensions.

Parametry

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      Wartość to „prawda”, jeśli rozszerzenie ma dostęp do schematu „file://”. W przeciwnym razie ma wartość fałsz.

Akcje powrotne

  • Promise<boolean>

    Chrome 99 i nowsze

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

isAllowedIncognitoAccess()

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

Pobiera stan dostępu rozszerzenia do trybu incognito. Jest to związane z kontrolowanym przez użytkownika ustawieniem „Dozwolone w trybie incognito” dla każdego rozszerzenia dostępnym na stronie chrome://extensions.

Parametry

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

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

Akcje powrotne

  • Promise<boolean>

    Chrome 99 i nowsze

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

sendRequest()

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

Użyj adresu runtime.sendMessage.

Wysyła pojedyncze żądanie do innych detektorów w rozszerzeniu. Usługa podobna do runtime.connect, ale wysyła tylko 1 żądanie z opcjonalną odpowiedzią. Zdarzenie extension.onRequest jest wywoływane na każdej stronie rozszerzenia.

Parametry

  • extensionId

    ciąg znaków opcjonalny

    Identyfikator rozszerzenia, z którym chcesz się połączyć. Jeśli go pominiesz, domyślnym rozszerzeniem będzie Twoje własne rozszerzenie.

  • Poproś

    Dowolne

  • wywołanie zwrotne

    funkcja opcjonalnie

    Chrome 99 i nowsze

    Parametr callback wygląda tak: 

    (response: any)=>void

    • odpowiedź

      Dowolne

      Obiekt odpowiedzi JSON wysłany przez moduł obsługi żądania. Jeśli podczas łączenia z rozszerzeniem wystąpi błąd, wywołanie zwrotne zostanie wykonane bez argumentów, a dla funkcji runtime.lastError zostanie ustawiony komunikat o błędzie.

Akcje powrotne

  • Obietnica<jakikolwiek>

    Chrome 99 i nowsze

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

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

Parametry

  • dane

    string,

Wydarzenia

onRequest

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

Użyj adresu runtime.onMessage.

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

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

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

    • Poproś

      Dowolne

    • sendResponse

      funkcja

      Parametr sendResponse wygląda tak: 

      ()=>void

onRequestExternal

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

Użyj adresu runtime.onMessageExternal.

Uruchamiane, gdy żądanie zostanie wysłane z innego rozszerzenia.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback wygląda tak: 

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

    • Poproś

      Dowolne

    • sendResponse

      funkcja

      Parametr sendResponse wygląda tak: 

      ()=>void