ブラウザー履歴とやりとりする history API を使用します。
downloads は HistoryItem オブジェクトとして扱われるのに注意します。このため、ダウンロードのために history.onVisited も発火します。
ブラウザー履歴はユーザーが訪れたページの時間順の記録です。history API では次の事ができます:
しかしながら、ユーザーは１つのページを何度も訪問することがあるので、このAPI は「訪問数」の概念もあります。したがってこの API を次のようにも使えます:
このAPIを使うには manifest.json ファイルで指定する "history" パーミッションが必要です。
型
history.TransitionType- ブラウザーがあるページにどのように移動したのかを記述
history.HistoryItem-
ブラウザー履歴のあるページに関する情報を提供
history.VisitItem-
ページへの単一の訪問を記述
関数
history.search()- ブラウザー履歴を検索して、所与の条件にマッチする
history.HistoryItemオブジェクトを得る history.getVisits()- 所定のページへの訪問についての情報を取得する
history.addUrl()- ブラウザー履歴に所定のページへの訪問のレコードを追加する
history.deleteUrl()- ブラウザー履歴から 所定のURLへのすべての訪問を削除する
history.deleteRange()- 所定の時間範囲でユーザーが訪問したすべてのページを削除する
history.deleteAll()- ブラウザー履歴からすべての訪問を削除する
イベント
history.onTitleChanged-
ユーザーがあるページに訪問してタイトルが記録された時に発火します
history.onVisited- ユーザーがあるページに
history.HistoryItemを提供しつつそのページを訪問した時に発火します history.onVisitRemoved-
ある URL がブラウザー履歴から完全に削除された時に発火します
ブラウザ実装状況
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.
| Chrome | Edge | Firefox | Firefox for Android | Opera | |
|---|---|---|---|---|---|
HistoryItem | あり | なし | 49 | なし | あり |
TransitionType | あり | なし | 50 | なし | あり |
VisitItem | あり | なし | 50 | なし | あり |
addUrl | あり | なし | 49 | なし | あり |
deleteAll | あり | なし | 49 | なし | あり |
deleteRange | あり | なし | 49 | なし | あり |
deleteUrl | あり | なし | 49 | なし | あり |
getVisits | あり | なし | 50 | なし | あり |
onTitleChanged | なし | なし | 55 | なし | なし |
onVisitRemoved | あり | なし | 50 | なし | あり |
onVisited | あり | なし | 50 * | なし | あり |
search | あり | なし | 49 | なし | あり |
Example extensions
この API は Chromium の chrome.history API に基づいています。また、このドキュメントは history.json における Chromium のコードに基づいています。
Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。
// 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.