chrome.extension

Opis

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

Typy

ViewType

Chrome w wersji 44 lub nowszej .

Typ widoku rozszerzenia.

Typ wyliczeniowy

"tab"

"wyskakujące okienko"

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 procesie incognito. To drugie ustawienie ma zastosowanie tylko do rozszerzeń z separatorem „podział” incognito_behavior.

Typ

wartość logiczna

lastError

≤ MV2 Wycofane od Chrome 58

Użyj adresu runtime.lastError.

Ustaw okres ważności wywołania zwrotnego, jeśli ansychronologiczny interfejs API rozszerzenia spowodował błąd. Jeśli nie wystąpił błąd lastError, wartość to undefined.

Typ

Obiekt

Właściwości

  • wiadomość

    ciąg znaków

    Opis, który wystąpił.

Metody

getBackgroundPage()

Tylko pierwszy plan .
chrome.extension.getBackgroundPage()

Zwraca „window” JavaScriptu dla strony w tle uruchomionej w bieżącym rozszerzeniu. Jeśli rozszerzenie nie ma strony w tle, zwraca wartość null.

Zwroty

  • Okno | nie zdefiniowano

getExtensionTabs()

≤ MV2 Tylko pierwszy plan Wycofano
chrome.extension.getExtensionTabs(
  windowId?: number,
)

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

Zwraca tablicę „okna” JavaScriptu dla każdej karty uruchomionej w bieżącym rozszerzeniu. Jeśli określono windowId, zwraca tylko „window” (okno). obiektów kart dołączonych do określonego okna.

Parametry

  • windowId

    liczba opcjonalnie

Zwroty

  • 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 rozszerzenia na pełny adres URL.

Parametry

  • ścieżka

    ciąg znaków

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

Zwroty

  • ciąg znaków

    Pełny adres URL zasobu.

getViews()

Tylko pierwszy plan .
chrome.extension.getViews(
  fetchProperties?: object,
)

Zwraca tablicę „okna” JavaScriptu dla każdej strony uruchomionej w bieżącym rozszerzeniu.

Parametry

  • fetchProperties

    obiekt opcjonalny

    • tabId

      liczba opcjonalnie

      Chrome w wersji 54 lub nowszej .

      Znajdź widok według identyfikatora karty. Jeśli pominiesz to pole, zwracane są wszystkie widoki.

    • typ

      Opcjonalny ViewType

      Typ widoku, który chcesz uzyskać. Jeśli nazwa zostanie pominięta, zwraca wszystkie widoki (w tym strony w tle i karty).

    • windowId

      liczba opcjonalnie

      Okno, do którego chcesz ograniczyć wyszukiwanie. Jeśli nazwa zostanie pominięta, zwraca wszystkie wyświetlenia.

Zwroty

  • Okno[]

    Tablica obiektów globalnych

isAllowedFileSchemeAccess()

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

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

Parametry

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      wartość logiczna

      Prawda, jeśli rozszerzenie ma dostęp do elementu „file://” schemat, a w przeciwnym razie – fałsz.

Zwroty

  • Promise<boolean>

    Chrome w wersji 99 lub nowszej .

    Obietnice są obsługiwane tylko na platformie Manifest V3 i nowszych, inne platformy muszą używać wywołań zwrotnych.

isAllowedIncognitoAccess()

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

Pobiera stan dostępu rozszerzenia do trybu incognito. Odpowiada to kontrolowanemu przez użytkownika rozszerzeniu „Dozwolone w trybie incognito” jest dostępne na stronie chrome://extensions.

Parametry

  • wywołanie zwrotne

    funkcja optional

    Parametr callback wygląda tak: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      wartość logiczna

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

Zwroty

  • Promise<boolean>

    Chrome w wersji 99 lub nowszej .

    Obietnice są obsługiwane tylko na platformie Manifest V3 i nowszych, inne platformy muszą używać wywołań zwrotnych.

sendRequest()

Obietnica ≤ MV2 Wycofano
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

Użyj adresu runtime.sendMessage.

Wysyła jedno żądanie do innych detektorów w obrębie rozszerzenia. Podobnie jak runtime.connect, ale wysyła tylko jedno żą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ślnie będzie używane Twoje własne rozszerzenie.

  • żądanie

    każdy

  • wywołanie zwrotne

    funkcja optional

    Chrome w wersji 99 lub nowszej .

    Parametr callback wygląda tak: 

    (response: any) => void

    • odpowiedź

      każdy

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

Zwroty

  • Obietnica<any>

    Chrome w wersji 99 lub nowszej .

    Obietnice są obsługiwane tylko na platformie Manifest V3 i nowszych, inne platformy muszą używać wywołań zwrotnych.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

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

Parametry

  • dane

    ciąg znaków

Wydarzenia

onRequest

&amp;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

    • żądanie

      każdy

    • sendResponse

      funkcja

      Parametr sendResponse wygląda tak: 

      () => void

onRequestExternal

&amp;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

    • żądanie

      każdy

    • sendResponse

      funkcja

      Parametr sendResponse wygląda tak: 

      () => void