Gets all tabs that have the specified properties, or all tabs if no properties are specified.
SyntaxEdit
browser.tabs.query(
queryInfo, // object
function(result) {...} // function
)
Parameters
queryInfo
object
. Thequery()
function will only get tabs whose properties match the properties included here. To learn more about these properties, see thetabs.Tab
documentation.
active
Optionalboolean
. Whether the tabs are active in their windows.pinned
Optionalboolean
. Whether the tabs are pinned.audible
Optionalboolean
. Whether the tabs are audible.muted
Optionalboolean
. Whether the tabs are muted.highlighted
Optionalboolean
. Whether the tabs are highlighted.currentWindow
Optionalboolean
. Whether the tabs are in the current window.lastFocusedWindow
Optionalboolean
. Whether the tabs are in the last focused window.status
Optionaltabs.TabStatus
. Whether the tabs have completed loading.title
Optionalstring
. Match page titles against a pattern.url
Optional
orstring
. Match tabs against one or more match patterns. Note that fragment identifiers are not matched.array
ofstring
windowId
Optionalinteger
. The ID of the parent window, orwindows.WINDOW_ID_CURRENT
for the current window.windowType
Optionaltabs.WindowType
. The type of window the tabs are in.index
Optionalinteger
. The position of the tabs within their windows.
callback
function
. The function is passed the following arguments:-
result
array
of
.tabs.Tab
Browser compatibilityEdit
ExamplesEdit
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.