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)

Beendet das Lauschen auf dieses Ereignis. Das Argument listener ist der zu entfernende Listener.

hasListener(listener)

Überprüft, ob listener für dieses Ereignis registriert ist. Gibt true zurück, wenn es lauscht, andernfalls false.

addListener Syntax

Parameter

listener

Die Funktion, die aufgerufen wird, wenn dieses Ereignis auftritt. Der Funktion werden diese Argumente übergeben:

tabId

integer. Die ID des aktualisierten Tabs.

changeInfo

object. Eigenschaften des Tabs, die sich geändert haben. Weitere Einzelheiten finden Sie im Abschnitt changeInfo.

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

properties

Array. Ein Array von Zeichenfolgen, das unterstützte Eigenschaftsnamen von tabs.Tab-Objekten enthält. Löst das Ereignis nur bei Änderungen einer der im Array benannten Eigenschaften aus. Diese Eigenschaften können verwendet werden:

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

Hinweis: Der Wert "url" 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 Tab aus, der durch diese ID identifiziert wird.

windowId

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

cookieStoreId

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

Zusätzliche Objekte

changeInfo

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

attention Optional

boolean. Gibt an, ob der Tab Aufmerksamkeit erregt. Zum Beispiel 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 false gesetzt ist, 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 einer, dessen Inhalt aus dem Speicher entladen wurde, aber im Tab-Bereich 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 (von einer Seite mit Favicon zu einer Seite ohne Favicon navigiert). Überprüfen Sie favIconUrl im tab stattdessen.

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 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 Stummschaltezustand 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 eröffnende Tab existiert und sich im gleichen 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 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);

Filterbeispiele

Protokollieren Sie Änderungen nur für 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 (d.h. Anheft- und Lösaktionen):

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 vorangehenden Filter, protokollieren Sie nur, wenn die pinned-Eigenschaft von Tabs geändert wird, 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, wobei sich der Tab im aktuellen Browserfenster befand, 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