sidebarAction.getTitle()

Gets the sidebar's title.

Just as you can set the title on a per-tab basis using sidebarAction.setTitle(), so you can retrieve a tab-specific title by passing the tab's ID into this function.

This is an asynchronous function that returns a Promise.

Syntax

var gettingTitle = browser.sidebarAction.getTitle(
  details               // object
)

Parameters

details

object. An object with the following properties:

tabIdOptional

integer. Get the title for the sidebar specific to the given tab.

windowId Optional

integer. Get the title for the sidebar specific to the given window.

• If windowId and tabId are both supplied, the function fails and the promise it returns is rejected.
• If windowId and tabId are both omitted, the global title is returned.

Return value

A Promise that will be fulfilled with a string containing the sidebar's title.

Browser compatibility

Examples

This code switches the title between "this" and "that" each time the user clicks the browser action

function toggleTitle(title) {
  if (title == "this") {
    browser.sidebarAction.setTitle({title: "that"});
  } else {
    browser.sidebarAction.setTitle({title: "this"});
  }
}

browser.browserAction.onClicked.addListener(() => {
  var gettingTitle = browser.sidebarAction.getTitle({});
  gettingTitle.then(toggleTitle);
});