Clients.matchAll()
Clients
インターフェイスの matchAll()
メソッドは、サービスワーカークライアント(Client
)オブジェクトのリストの Promise
を返します。 関連するサービスワーカーのオリジンと同じオリジンを持つすべてのサービスワーカークライアントを返すには、options
パラメーターを含めます。 オプションが含まれていない場合、メソッドは、サービスワーカーによって制御されるサービスワーカークライアントのみを返します。
構文
self.clients.matchAll(options).then(function(clients) { // クライアントのリストで何かを行います });
パラメーター
options
省略可-
照合操作のオプションを設定できるオプションオブジェクト。 利用可能なオプションは次のとおりです。
includeUncontrolled
:Boolean
—true
に設定すると、照合操作は、現在のサービスワーカーと同じオリジンを共有するすべてのクライアントを返します。 それ以外の場合は、現在のサービスワーカーによって制御されているサービスワーカークライアントのみを返します。 デフォルトはfalse
です。type
: 一致させるクライアントの種類を設定します。 使用可能な値は、"window"
、"worker"
、"sharedworker"
、"all"
です。 デフォルトは"all"
です。
戻り値
例
clients.matchAll(options).then(function(clientList) {
for (var i = 0 ; i < clientList.length ; i++) {
if (clientList[i].url === 'index.html') {
clients.openWindow(clientList[i]);
// または、一致するクライアントに関係する何かを行う
}
}
});
仕様
Specification |
---|
Service Workers # clients-matchall |
ブラウザーの互換性
BCD tables only load in the browser