tabs.query()

指定されたプロパティを持つ全てのタブを取得します。何も指定しない場合、全てのタブを取得します。

この関数は Promise を返す非同期関数です。

構文

var querying = browser.tabs.query(
  queryInfo             // object
)

パラメータ

queryInfo

object. query() 関数はここで指定されたプロパティにマッチするタブだけを取得します。 このプロパティについての詳細は tabs.Tab を参照してください。

activeOptional

boolean. 各ウインドウの中でアクティブかどうか。

audibleOptional

boolean. 音が鳴らされているか。

autoDiscardableOptional

boolean. リソースが少なくなったときにブラウザーによって自動的にdiscardできるか。

cookieStoreId Optional

string. Use this to return only tabs whose cookie store ID is cookieStoreId. This option is only available if the extension has the "cookies" permission.

currentWindowOptional

boolean. カレントウインドウの中のタブか。

discardedOptional

boolean. タブがdiscardされているか。 discardされたタブはコンテンツがメモリからアンロードされているが、タブの一覧には表示されたままになります。コンテンツはタブが次にアクティブになったときにリロードされます。

highlightedOptional

boolean. ハイライトされているか。

indexOptional

integer. ウィンドウの中での位置。

mutedOptional

boolean. ミュートにされているか。

lastFocusedWindowOptional

boolean. 最後にフォーカスされたウインドウのタブか。

openerTabIdOptional

integer. そのタブを開いたタブのID。

pinnedOptional

boolean. ピン留めされているか。

statusOptional

tabs.TabStatus. ロードが完了しているか。

titleOptional

string. ページのタイトル。

urlOptional

string or array of string. Match tabs against one or more match patterns. Note that fragment identifiers are not matched.

windowIdOptional

integer. そのウインドウのID。カレントウインドウの場合は、 windows.WINDOW_ID_CURRENT 。

windowTypeOptional

tabs.WindowType. そのタブの属するウインドウの種類。

戻り値

A Promise that will be fulfilled with an array of tabs.Tab objects, containing infomation about each matching tab. If any error occurs, the promise will be rejected with an error message.

ブラウザ実装状況

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

例

全てのタブを取得する例：

function logTabs(tabs) {
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({});
querying.then(logTabs, onError);

カレントウインドウの全てのタブを取得する例：

function logTabs(tabs) {
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({currentWindow: true});
querying.then(logTabs, onError);

カレントウインドウのアクティブなタブを取得する例：

function logTabs(tabs) {
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({currentWindow: true, active: true});
querying.then(logTabs, onError);

"mozilla.org" またはそのサブドメイン下のHTTP/HTTPS URLを開いている全てのタブを取得する例：

function logTabs(tabs) {
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({url: "*://*.mozilla.org/*"});
querying.then(logTabs, onError);

moz-extension:// URLを開いている全てのタブを取得する例：

function logTabs(tabs) {
  console.log(tabs);
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({url: "moz-extension://*/*"});
querying.then(logTabs, onError);

この拡張機能のURLを開いている全てのタブを取得する例：

function logTabs(tabs) {
  console.log(tabs);
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({url: browser.extension.getURL("*")});
querying.then(logTabs, onError);

Example extensions

• annotate-page
• apply-css
• beastify
• bookmark-it
• chill-out
• contextual-identities
• cookie-bg-picker
• find-across-tabs
• history-deleter
• imagify
• list-cookies
• react-es6-popup
• session-state
• tabs-tabs-tabs

// 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.