chrome.geschiedenis

Beschrijving

Gebruik de chrome.history API om te communiceren met de browsergeschiedenis van bezochte pagina's. U kunt URL's in de browsergeschiedenis toevoegen, verwijderen en ernaar opvragen. Zie Pagina's overschrijven om de geschiedenispagina te overschrijven met uw eigen versie.

Machtigingen

history

Gebruik de geschiedenis-API om te communiceren met de browsergeschiedenis van de gebruiker.

Als u de geschiedenis-API wilt gebruiken, geeft u de machtiging "history" op in het extensiemanifest . Bijvoorbeeld:

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

Concepten en gebruik

Overgangstypen

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

Voorbeelden

Om deze API te proberen, installeert u het History API-voorbeeld uit de chrome-extension-samples- repository.

Soorten

HistoryItem

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

Eigenschappen

  • Identiteitskaart

    snaar

    De unieke ID voor het item.

  • laatstebezoektijd

    nummer optioneel

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

  • titel

    tekenreeks optioneel

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

  • getyptCount

    nummer optioneel

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

  • URL

    tekenreeks optioneel

    De URL waar een gebruiker naartoe navigeert.

  • bezoekCount

    nummer optioneel

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

TransitionType

Chroom 44+

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.

"getypt"
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 gebruikersinterface, bijvoorbeeld via een menu-item.

"auto_subframe"
De gebruiker is op deze pagina terechtgekomen via subframenavigatie waar hij niet om heeft gevraagd, bijvoorbeeld doordat een advertentie in een frame op de vorige pagina is geladen. Deze genereren niet altijd nieuwe navigatie-items in de terug- en vooruitmenu's.

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

"gegenereerd"
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 suggestie van Google Zoeken. Een overeenkomst kan bijvoorbeeld de URL van een resultatenpagina van Google Zoeken hebben, maar kan voor de gebruiker verschijnen als 'Zoek op Google naar ...'. Deze verschillen van getypte navigatie omdat de gebruiker de bestemmings-URL niet heeft getypt of gezien. Ze hebben ook betrekking op zoekwoordnavigatie.

"auto_topniveau"
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 te verzenden. Niet alle formulierinzendingen gebruiken dit overgangstype.

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

"trefwoord"
De URL voor deze pagina is gegenereerd op basis van een vervangbaar trefwoord dat niet de standaardzoekmachine is.

"trefwoord_gegenereerd"
Komt overeen met een bezoek gegenereerd voor een trefwoord.

UrlDetails

Chroom 88+

Eigenschappen

  • URL

    snaar

    De URL voor de bewerking. Het moet de indeling hebben zoals geretourneerd door een aanroep van history.search() .

VisitItem

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

Eigenschappen

  • Identiteitskaart

    snaar

    De unieke id voor de bijbehorende history.HistoryItem .

  • isLokaal

    Booleaans

    Chroom 115+

    Waar als het bezoek afkomstig is van dit apparaat. Onwaar als het vanaf een ander apparaat is gesynchroniseerd.

  • verwijzendeVisitId

    snaar

    Het bezoek-ID van de verwijzer.

  • overgang

    Overgangstype

    Het overgangstype voor dit bezoek van de verwijzer.

  • bezoekID

    snaar

    De unieke identificatie voor dit bezoek.

  • bezoekTijd

    nummer optioneel

    Toen dit bezoek plaatsvond, weergegeven in milliseconden sinds het tijdperk.

Methoden

addUrl()

Belofte
chrome.history.addUrl(
  details: UrlDetails,
  callback?: function,
)

Voegt een URL toe aan de geschiedenis van het huidige tijdstip met het overgangstype 'link'.

Parameters

  • details

    URLDetails

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 96+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

deleteAll()

Belofte
chrome.history.deleteAll(
  callback?: function,
)

Verwijdert alle items uit de geschiedenis.

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 96+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

deleteRange()

Belofte
chrome.history.deleteRange(
  range: object,
  callback?: function,
)

Verwijdert alle items binnen het opgegeven datumbereik uit de geschiedenis. Pagina's worden niet uit de geschiedenis verwijderd, tenzij alle bezoeken binnen het bereik vallen.

Parameters

  • bereik

    voorwerp

    • eindTijd

      nummer

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

    • startTijd

      nummer

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

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 96+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

deleteUrl()

Belofte
chrome.history.deleteUrl(
  details: UrlDetails,
  callback?: function,
)

Verwijdert alle exemplaren van de opgegeven URL uit de geschiedenis.

Parameters

  • details

    URLDetails

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 96+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getVisits()

Belofte
chrome.history.getVisits(
  details: UrlDetails,
  callback?: function,
)

Haalt informatie op over bezoeken aan een URL.

Parameters

  • details

    URLDetails

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (results: VisitItem[]) => void

Retouren

  • Beloof < VisitItem []>

    Chroom 96+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Belofte
chrome.history.search(
  query: object,
  callback?: function,
)

Zoekt in de geschiedenis naar de laatste bezoektijd van elke pagina die aan de zoekopdracht voldoet.

Parameters

  • vraag

    voorwerp

    • eindTijd

      nummer optioneel

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

    • maxResultaten

      nummer optioneel

      Het maximale aantal resultaten dat kan worden opgehaald. Standaard ingesteld op 100.

    • startTijd

      nummer optioneel

      Beperk de resultaten tot degenen die na deze datum zijn bezocht, weergegeven in milliseconden sinds het tijdperk. Als er geen eigenschap is opgegeven, wordt deze standaard ingesteld op 24 uur.

    • tekst

      snaar

      Een vrije-tekstquery aan de geschiedenisservice. Laat dit leeg om alle pagina's op te halen.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (results: HistoryItem[]) => void

Retouren

  • Beloof < GeschiedenisItem []>

    Chroom 96+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Evenementen

onVisited

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

Wordt geactiveerd wanneer een URL wordt bezocht, waarbij de HistoryItem gegevens voor die URL worden verstrekt. Deze gebeurtenis wordt geactiveerd voordat de pagina is geladen.

Parameters

onVisitRemoved

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

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

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (removed: object) => void

    • VERWIJDERD

      voorwerp

      • alleGeschiedenis

        Booleaans

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

      • URL's

        tekenreeks[] optioneel