tabs.onUpdated

Wird ausgelöst, wenn ein Tab aktualisiert wird.

Wenn der Benutzer in einem Tab zu einer neuen URL navigiert, generiert dies in der Regel mehrere onUpdated-Ereignisse, da verschiedene Eigenschaften des tabs.Tab-Objekts aktualisiert werden. Dies schließt die url ein, aber möglicherweise auch die Eigenschaften title und favIconUrl. Die status-Eigenschaft wechselt zwischen "loading" und "complete".

Dieses Ereignis wird auch bei Änderungen an den Eigenschaften eines Tabs ausgelöst, die keine Navigation beinhalten, wie z.B. das Anheften und Lösen (was die pinned-Eigenschaft aktualisiert) sowie das Stummschalten oder Aufheben der Stummschaltung (was die Eigenschaften audible und mutedInfo aktualisiert).

Sie können dieses Ereignis filtern, sodass es nur für Tabs ausgelöst wird, deren URLs bestimmte Muster erfüllen, Änderungen an bestimmten Eigenschaften betreffen, sich auf einen bestimmten Tab oder ein Fenster beziehen oder jede Kombination dieser Einschränkungen umfassen.

Syntax

js
browser.tabs.onUpdated.addListener(
  listener, // function
  filter     // optional object
)
browser.tabs.onUpdated.removeListener(listener)
browser.tabs.onUpdated.hasListener(listener)

Ereignisse haben drei Funktionen:

addListener(callback, filter)

Fügt diesem Ereignis einen Listener hinzu.

removeListener(listener)

Stoppt das Abhören dieses Ereignisses. Das Argument listener ist der zu entfernende Listener.

hasListener(listener)

Prüft, ob listener für dieses Ereignis registriert ist. Gibt true zurück, wenn es zuhört, andernfalls false.

addListener-Syntax

Parameter

listener

Die Funktion, die aufgerufen wird, wenn dieses Ereignis eintritt. Die Funktion erhält diese Argumente:

tabId

integer. Die ID des aktualisierten Tabs.

changeInfo

object. Eigenschaften des Tabs, die sich geändert haben. Siehe den Abschnitt changeInfo für weitere Details.

tab

tabs.Tab. Der neue Zustand des Tabs.

filter Optional

object. Eine Sammlung von Filtern, die die an diesen Listener gesendeten Ereignisse einschränken. Dieses Objekt kann eine oder mehrere dieser Eigenschaften haben. Ereignisse werden nur gesendet, wenn sie alle angegebenen Filter erfüllen.

urls

Array. Ein Array von Match-Mustern. Löst das Ereignis nur für Tabs aus, deren aktuelle url-Eigenschaft mit einem der Muster übereinstimmt.

properties

Array. Ein Array von Zeichenfolgen, die die unterstützten Eigenschaftsnamen des tabs.Tab-Objekts enthalten. Das Ereignis wird nur bei Änderungen an einer der im Array genannten Eigenschaften ausgelöst. Diese Eigenschaften können verwendet werden:

  • "attention"
  • "autoDiscardable"
  • "audible"
  • "discarded"
  • "favIconUrl"
  • "groupId"
  • "hidden"
  • "isArticle"
  • "mutedInfo"
  • "openerTabId"
  • "pinned"
  • "status"
  • "title"
  • "url"

Hinweis: Der "url"-Wert wird seit Firefox 88 unterstützt. In Firefox 87 und früher können "url"-Änderungen durch Filtern nach "status" beobachtet werden.

tabId

Integer. Löst dieses Ereignis nur für den durch diese ID identifizierten Tab aus.

windowId

Integer. Löst dieses Ereignis nur für Tabs im durch diese ID identifizierten Fenster aus.

Zusätzliche Objekte

changeInfo

Listet die Änderungen am Zustand des aktualisierten Tabs auf. Um mehr über diese Eigenschaften zu erfahren, sehen Sie sich die Dokumentation zu tabs.Tab an. Beachten Sie, dass nicht alle Eigenschaften von tabs.Tab unterstützt werden.

attention Optional

boolean. Gibt an, ob der Tab Aufmerksamkeit erregt. Beispielsweise ist attention true, wenn der Tab ein modales Dialogfeld anzeigt.

audible Optional

boolean. Der neue hörbare Zustand des Tabs.

autoDiscardable Optional

boolean. Ob der Tab vom Browser verworfen werden kann. Der Standardwert ist true. Wenn auf false gesetzt, kann der Tab nicht automatisch vom Browser verworfen werden. Der Tab kann jedoch durch tabs.discard verworfen werden.

discarded Optional

boolean. Ob der Tab verworfen wurde. Ein verworfener Tab ist einer, dessen Inhalt aus dem Speicher entladen wurde, aber im Tab-Streifen sichtbar bleibt. Sein Inhalt wird beim nächsten Aktivieren neu geladen.

favIconUrl Optional

string. Die neue Favicon-URL des Tabs. Wird nicht enthalten, wenn ein Tab sein Favicon verliert (von einer Seite mit Favicon zu einer Seite ohne wechseln). Überprüfen Sie stattdessen favIconUrl im Tab.

groupId Optional

integer. Die ID der Gruppe, in der sich die Tabs befinden oder -1 (tabGroups.TAB_GROUP_ID_NONE) für nicht gruppierte Tabs.

hidden Optional

boolean. Wahr, wenn der Tab versteckt ist.

isArticle Optional

boolean. Wahr, wenn der Tab ein Artikel ist und somit für die Anzeige im Reader-Modus geeignet ist.

mutedInfo Optional

tabs.MutedInfo. Der neue Stummschaltungszustand des Tabs und der Grund für die Änderung.

openerTabId Optional

integer. Die ID des Tabs, der diesen Tab geöffnet hat, falls vorhanden. Diese Eigenschaft ist nur vorhanden, wenn der öffnende Tab existiert und sich im selben Fenster befindet.

pinned Optional

boolean. Der neue angeheftete Zustand des Tabs.

status Optional

string. Der Status des Tabs. Kann entweder loading oder complete sein.

title Optional

string. Der neue Titel des Tabs.

url Optional

string. Die URL des Tabs, falls sie sich geändert hat.

Beispiele

Hören Sie zu und protokollieren Sie alle Änderungsinformationen und den neuen Zustand:

js
function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}

browser.tabs.onUpdated.addListener(handleUpdated);

Protokollieren Sie Änderungen an URLs:

js
function handleUpdated(tabId, changeInfo, tabInfo) {
  if (changeInfo.url) {
    console.log(`Tab: ${tabId} URL changed to ${changeInfo.url}`);
  }
}

browser.tabs.onUpdated.addListener(handleUpdated);

Filterbeispiele

Protokollieren Sie Änderungen nur an Tabs, deren url-Eigenschaft durch https://developer.mozilla.org/* oder https://mastodon.social/@mdn übereinstimmt:

js
const pattern1 = "https://developer.mozilla.org/*";
const pattern2 = "https://mastodon.social/@mdn";

const filter = {
  urls: [pattern1, pattern2],
};

function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}

browser.tabs.onUpdated.addListener(handleUpdated, filter);

Protokollieren Sie Änderungen nur an der pinned-Eigenschaft von Tabs (also Anheft- und Lösvorgänge):

js
const filter = {
  properties: ["pinned"],
};

function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}

browser.tabs.onUpdated.addListener(handleUpdated, filter);

Kombinieren Sie beide vorherigen Filter und protokollieren Sie nur, wenn die pinned-Eigenschaft von Tabs geändert wird, deren url-Eigenschaft durch https://developer.mozilla.org/* oder https://mastodon.social/@mdn übereinstimmt:

js
const pattern1 = "https://developer.mozilla.org/*";
const pattern2 = "https://mastodon.social/@mdn";

const filter = {
  urls: [pattern1, pattern2],
  properties: ["pinned"],
};

function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}

browser.tabs.onUpdated.addListener(handleUpdated, filter);

Protokollieren Sie Änderungen nur, wenn die pinned-Eigenschaft von Tabs geändert wird, deren url-Eigenschaft durch https://developer.mozilla.org/* oder https://mastodon.social/@mdn übereinstimmt und der Tab Teil des aktuellen Browserfensters war, als das Aktualisierungsereignis ausgelöst wurde:

js
const pattern1 = "https://developer.mozilla.org/*";
const pattern2 = "https://mastodon.social/@mdn";

const filter = {
  urls: [pattern1, pattern2],
  properties: ["pinned"],
  windowId: browser.windows.WINDOW_ID_CURRENT,
};

function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}

browser.tabs.onUpdated.addListener(handleUpdated, filter);

Beispielerweiterungen

Browser-Kompatibilität

Hinweis: Diese API basiert auf Chromiums chrome.tabs API. Diese Dokumentation stammt aus tabs.json im Chromium-Code.