Mozilla's getting a new look. What do you think? https://mzl.la/brandsurvey

getAll()

Gets all commands for this add-on that you have registered using the commands manifest.json key.

The commands are returned as an array of commands.Command objects. Alternately, if you are using the promise-based version of the API, browser.commands.getAll(), the commands are passed into the onFulfilled argument to Promise.then().

Syntax

chrome.commands.getAll(
  function(            // function
    alarms             //   array of commands.Command objects
  ) {...}
)

This API is also available as browser.commands.getAll() in a version that returns a promise:

var getCommands = browser.commands.getAll();
getCommands.then(
  function(            // function
    alarms             //   array of commands.Command objects
  ) {...}
);

Parameters

callback
function. The function is passed the following arguments:
alarms
array of commands.Command. All the commands for this add-on that you have registered using the commands manifest.json key. If no commands were registered, the array will be empty.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 48.0 No 33

Examples

Callback-based version:

function logCommands(commandArray) {
  commandArray.forEach(function(command) {
    console.log(command);
  });
}

chrome.commands.getAll(logCommands);

Promise-based version:

function logCommands(commands) {
  commandsArray.forEach(function(command) {
    console.log(command);
  });
}

var getCommands = browser.commands.getAll();
getCommands.then(logCommands);

Example add-ons

Acknowledgements

This API is based on Chromium's chrome.commands API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: Makyen, wbamberg
 Last updated by: Makyen,