tabs.query()

In This Article

Syntax
1. Parameters
Browser compatibility
Examples
1. Example add-ons

Gets all tabs that have the specified properties, or all tabs if no properties are specified.

Syntax

browser.tabs.query(
  queryInfo,             // object
  function(result) {...} // function
)

Parameters

queryInfo

object. The query() function will only get tabs whose properties match the properties included here. To learn more about these properties, see the tabs.Tab documentation.

activeOptional: boolean. Whether the tabs are active in their windows.
pinnedOptional: boolean. Whether the tabs are pinned.
audibleOptional: boolean. Whether the tabs are audible.
mutedOptional: boolean. Whether the tabs are muted.
highlightedOptional: boolean. Whether the tabs are highlighted.
currentWindowOptional: boolean. Whether the tabs are in the current window.
lastFocusedWindowOptional: boolean. Whether the tabs are in the last focused window.
statusOptional: tabs.TabStatus. Whether the tabs have completed loading.
titleOptional: string. Match page titles against a pattern.
urlOptional: string or array of string. Match tabs against one or more match patterns. Note that fragment identifiers are not matched.
windowIdOptional: integer. The ID of the parent window, or windows.WINDOW_ID_CURRENT for the current window.
windowTypeOptional: tabs.WindowType. The type of window the tabs are in.
indexOptional: integer. The position of the tabs within their windows.

callback

function. The function is passed the following arguments:

result: array of tabs.Tab.

	Edge	Firefox	Chrome	Opera
Basic support	?	45.0	Yes	33

	Firefox
Basic support	No

Examples

Example add-ons

Acknowledgements

This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Document Tags and Contributors

Tags:

Contributors to this page: wbamberg

Last updated by: wbamberg, Apr 14, 2016, 4:20:15 PM