browser.history

Beschrijving

Gebruik de chrome.history API om te communiceren met de browsergeschiedenis van bezochte pagina's. Je kunt URL's toevoegen, verwijderen en opvragen in de geschiedenis van de browser. Als je de geschiedenispagina wilt overschrijven met je eigen versie, ga je naar Pagina's overschrijven.

Rechten

history

Gebruik de History API om te communiceren met de browsergeschiedenis van de gebruiker.

Als je de geschiedenis-API wilt gebruiken, definieer je het recht "history" in het extensiemanifest. Voorbeeld:

{
  "name": "My extension",
  ...
  "permissions": [
    "history"
  ],
  ...
}

Concepten en gebruik

Overgangstypen

De History API gebruikt overgangstypen om te beschrijven hoe de browser naar een bepaalde URL is genavigeerd tijdens een bepaald bezoek. Als een gebruiker bijvoorbeeld een pagina bezoekt door op een link op een andere pagina te klikken, is het overgangstype 'link'. Bekijk de referentiecontent voor een lijst met overgangstypen.

Voorbeelden

Als je deze API wilt proberen, installeer je het voorbeeld van de History API uit de repository chrome-extension-samples.

Typen

HistoryItem

Een object dat één resultaat van een geschiedenisquery inkapselt.

Eigenschappen

  • id

    tekenreeks

    De unieke ID van het item.

  • lastVisitTime

    number optioneel

    Wanneer deze pagina voor het laatst is geladen, weergegeven in milliseconden sinds het tijdperk.

  • titel

    tekenreeks optioneel

    De titel van de pagina toen deze voor het laatst werd geladen.

  • typedCount

    number optioneel

    Het aantal keren dat de gebruiker naar deze pagina is genavigeerd door het adres in te typen.

  • url

    tekenreeks optioneel

    De URL waarnaar een gebruiker is genavigeerd.

  • visitCount

    number optioneel

    Het aantal keren dat de gebruiker naar deze pagina is genavigeerd.

TransitionType

Chrome 44+ browser.* sinds Chrome 148

Het overgangstype voor dit bezoek van de verwijzer.

Enum

"link"
De gebruiker is op deze pagina terechtgekomen door op een link op een andere pagina te klikken.

'typed'
De gebruiker is op deze pagina terechtgekomen door de URL in de adresbalk te typen. Dit wordt ook gebruikt voor andere expliciete navigatieacties.

"auto_bookmark"
De gebruiker is op deze pagina terechtgekomen via een suggestie in de UI, bijvoorbeeld via een menu-item.

"auto_subframe"
De gebruiker is op deze pagina terechtgekomen via subframe-navigatie die de gebruiker niet heeft aangevraagd, bijvoorbeeld via een advertentie die in een frame op de vorige pagina is geladen. Deze genereren niet altijd nieuwe navigatie-items in de menu's Terug en Vooruit.

manual_subframe
De gebruiker is op deze pagina terechtgekomen door iets in een subframe te selecteren.

"generated"
De gebruiker is op deze pagina terechtgekomen door in de adresbalk te typen en een item te selecteren dat niet op een URL leek, zoals een Google Zoeken-zoeksuggestie. Een overeenkomst kan bijvoorbeeld de URL van een Google-zoekresultatenpagina hebben, maar voor de gebruiker verschijnen als 'Google doorzoeken op ...'. Deze verschillen van getypte navigaties omdat de gebruiker de bestemmings-URL niet heeft getypt of gezien. Ze zijn ook gerelateerd aan zoekwoordnavigaties.

"auto_toplevel"
De pagina is opgegeven op de opdrachtregel of is de startpagina.

form_submit
De gebruiker is op deze pagina terechtgekomen door waarden in een formulier in te vullen en het formulier in te dienen. Niet alle formulierinzendingen gebruiken dit overgangstype.

"reload"
De gebruiker heeft de pagina opnieuw geladen door op de knop Opnieuw laden te klikken of door op Enter te drukken in de adresbalk. Sessieherstel en Gesloten tabblad opnieuw openen gebruiken dit overgangstype ook.

"keyword"
De URL voor deze pagina is gegenereerd op basis van een vervangbaar zoekwoord dat niet de standaard zoekprovider is.

"keyword_generated"
Komt overeen met een bezoek dat is gegenereerd voor een zoekwoord.

UrlDetails

Chrome 88+ browser.* sinds Chrome 148

Eigenschappen

  • url

    tekenreeks

    De URL voor de bewerking. De indeling moet overeenkomen met de indeling die wordt geretourneerd door een aanroep naar history.search().

VisitItem

Een object dat één bezoek aan een URL inkapselt.

Eigenschappen

  • id

    tekenreeks

    De unieke ID voor de bijbehorende history.HistoryItem.

  • isLocal

    booleaans

    Chrome 115+ browser.* sinds Chrome 148

    Waar als het bezoek is gestart op dit apparaat. Onwaar als de activiteit is gesynchroniseerd vanaf een ander apparaat.

  • referringVisitId

    tekenreeks

    De bezoek-ID van de verwijzer.

  • overgang

    TransitionType

    Het overgangstype voor dit bezoek van de verwijzer.

  • visitId

    tekenreeks

    De unieke ID voor dit bezoek.

  • visitTime

    number optioneel

    Wanneer dit bezoek heeft plaatsgevonden, weergegeven in milliseconden sinds het tijdperk.

Methoden

addUrl()

browser.history.addUrl(
  details: UrlDetails,
): Promise<void>

Voegt een URL toe aan de geschiedenis op de huidige tijd met het overgangstype link.

Parameters

Retourzendingen

  • Promise<void>

    Chrome 96+ browser.* sinds Chrome 148

deleteAll()

browser.history.deleteAll(): Promise<void>

Hiermee worden alle items uit de geschiedenis verwijderd.

Retourzendingen

  • Promise<void>

    Chrome 96+ browser.* sinds Chrome 148

deleteRange()

browser.history.deleteRange(
  range: object,
): Promise<void>

Verwijdert alle items binnen de aangegeven periode uit de geschiedenis. Pagina's worden niet uit de geschiedenis verwijderd, tenzij alle bezoeken binnen de periode vallen.

Parameters

  • bereik

    object

    • endTime

      getal

      Items die vóór deze datum aan de geschiedenis zijn toegevoegd, weergegeven in milliseconden sinds het tijdperk.

    • startTime

      getal

      Items die na deze datum aan de geschiedenis zijn toegevoegd, weergegeven in milliseconden sinds het tijdperk.

Retourzendingen

  • Promise<void>

    Chrome 96+ browser.* sinds Chrome 148

deleteUrl()

browser.history.deleteUrl(
  details: UrlDetails,
): Promise<void>

Verwijdert alle instanties van de opgegeven URL uit de geschiedenis.

Parameters

Retourzendingen

  • Promise<void>

    Chrome 96+ browser.* sinds Chrome 148

getVisits()

browser.history.getVisits(
  details: UrlDetails,
): Promise<VisitItem[]>

Hiermee wordt informatie over bezoeken aan een URL opgehaald.

Parameters

Retourzendingen

  • Promise<VisitItem[]>

    Chrome 96+ browser.* sinds Chrome 148 
browser.history.search(
  query: object,
): Promise<HistoryItem[]>

Zoekt in de geschiedenis naar de laatste bezoektijd van elke pagina die overeenkomt met de zoekopdracht.

Parameters

  • query

    object

    • endTime

      number optioneel

      Beperk de resultaten tot de resultaten die vóór deze datum zijn bezocht, weergegeven in milliseconden sinds het tijdperk.

    • maxResults

      number optioneel

      Het maximumaantal resultaten dat moet worden opgehaald. De standaardinstelling is 100.

    • startTime

      number optioneel

      Beperk de resultaten tot de resultaten die na deze datum zijn bezocht, weergegeven in milliseconden sinds het tijdvak. Als de property niet is opgegeven, is de standaardwaarde 24 uur.

    • tekst

      tekenreeks

      Een zoekopdracht met vrije tekst naar de geschiedenisservice. Laat dit leeg om alle pagina's op te halen.

Retourzendingen

  • Promise<HistoryItem[]>

    Chrome 96+ browser.* sinds Chrome 148

Evenementen

onVisited

browser.history.onVisited.addListener(
  callback: function,
)

Wordt geactiveerd als een URL wordt bezocht en levert de HistoryItem-gegevens voor die URL. Deze gebeurtenis wordt geactiveerd voordat de pagina is geladen.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (result: HistoryItem) => void

onVisitRemoved

browser.history.onVisitRemoved.addListener(
  callback: function,
)

Wordt geactiveerd als een of meer URL's uit de geschiedenis worden verwijderd. Als alle bezoeken zijn verwijderd, wordt de URL uit de geschiedenis verwijderd.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (removed: object) => void

    • verwijderd

      object

      • allHistory

        booleaans

        Waar als de hele geschiedenis is verwijderd. Als dit waar is, zijn de URL's leeg.

      • URL’s

        string[] optioneel