tabs.onUpdated

Syntax

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)

Hört auf, dieses Ereignis zu hören. Das listener-Argument ist der zu entfernende Listener.

hasListener(listener)

Überprü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. Der Funktion werden diese Argumente übergeben:

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 Reihe 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 Musterdefinitionen. Löst das Ereignis nur für Tabs aus, deren aktuelle url-Eigenschaft mit einem der Muster übereinstimmt.

properties

Array. Ein Array von Zeichenfolgen, bestehend aus unterstützten tabs.Tab-Objekteigenschaftsnamen. Löst das Ereignis nur für Änderungen an einer der in dem Array genannten Eigenschaften aus. Diese Eigenschaften können verwendet werden:

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

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

tabId

Integer. Löst dieses Ereignis nur für den Tab mit dieser ID aus.

windowId

Integer. Löst dieses Ereignis nur für Tabs im Fenster mit dieser ID aus.

cookieStoreId

Integer. Löst dieses Ereignis nur für Tabs im Cookie-Speicher mit dieser ID aus.

Zusätzliche Objekte

changeInfo

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

attention Optional

boolean. Gibt an, ob der Tab Aufmerksamkeit erregt. Beispielsweise ist attention true, wenn der Tab einen modalen Dialog 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 Browser den Tab nicht automatisch verwerfen. Der Tab kann jedoch durch tabs.discard verworfen werden.

discarded Optional

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

favIconUrl Optional

string. Die neue Favicon-URL des Tabs. Wird nicht eingeschlossen, wenn ein Tab sein Favicon verliert (z. B. beim Navigieren von einer Seite mit Favicon zu einer Seite ohne Favicon). Prüfen Sie favIconUrl stattdessen im tab.

groupId Optional

integer. Die ID der Gruppe, zu der die Tabs gehören, oder -1 (tabGroups.TAB_GROUP_ID_NONE) für nicht gruppierte Tabs.

hidden Optional

boolean. Wahr, wenn der Tab hidden ist.

isArticle Optional

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

mutedInfo Optional

tabs.MutedInfo. Der neue stumme Zustand 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 im selben Fenster ist.

pinned Optional

boolean. Der neue fixierte Zustand des Tabs.

splitViewId Optional

integer. Die ID der geteilten Ansicht, zu der der Tab gehört. Wird auf tabs.SPLIT_VIEW_ID_NONE gesetzt, wenn der Tab nicht zu einer geteilten Ansicht gehört.

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, wenn sie sich geändert hat.

Beispiele

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

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:

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

browser.tabs.onUpdated.addListener(handleUpdated);

Beispiele für Filterung

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

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 (das heißt, Anheften und Lösen von Aktionen):

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 sich die pinned-Eigenschaft von Tabs ändert, deren url-Eigenschaft mit https://developer.mozilla.org/* oder https://mastodon.social/@mdn übereinstimmt:

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 sich die pinned-Eigenschaft von Tabs ändert, deren url-Eigenschaft mit https://developer.mozilla.org/* oder https://mastodon.social/@mdn übereinstimmt und der Tab Teil des aktuellen Browserfensters war, als das Aktualisierungsereignis ausgelöst wurde:

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

• annotate-page
• apply-css
• bookmark-it
• chill-out
• cookie-bg-picker
• history-deleter
• session-state

Browser-Kompatibilität