chrome.geschiedenis

Beschrijving

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

Machtigingen

history

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

Om de geschiedenis-API te gebruiken, declareert u de machtiging "history" in het extensiemanifest . Bijvoorbeeld:

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

Begrippen en gebruik

Overgangstypen

De geschiedenis-API gebruikt overgangstypen om te beschrijven hoe de browser bij een specifiek bezoek naar een bepaalde URL navigeerde. 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 uit te proberen, installeert u het voorbeeld van de geschiedenis-API uit de chrome-extension-samples- repository.

Typen

HistoryItem

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

Eigenschappen

  • id

    snaar

    De unieke identificatie voor het item.

  • laatsteBezoektijd

    nummer optioneel

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

  • titel

    string optioneel

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

  • getyptAantal

    nummer optioneel

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

  • url

    string optioneel

    De URL waar een gebruiker naartoe navigeert.

  • bezoekAantal

    nummer optioneel

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

TransitionType

Chroom 44+

Het overgangstype voor dit bezoek vanaf de verwijzende partij.

Enum

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

"getypt"
De gebruiker kwam op deze pagina terecht door de URL in de adresbalk te typen. Deze URL wordt ook gebruikt voor andere expliciete navigatieacties.

"auto_bladwijzer"
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 die hij/zij niet heeft aangevraagd, bijvoorbeeld via een advertentie die in een frame op de vorige pagina wordt geladen. Deze genereren niet altijd nieuwe navigatie-items in de vorige en volgende menu's.

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

"gegenereerd"
De gebruiker kwam op deze pagina terecht door in de adresbalk te typen en een item te selecteren dat niet op een URL leek, zoals een suggestie van Google Zoeken. Een match kan bijvoorbeeld de URL van een pagina met Google-zoekresultaten bevatten, maar de gebruiker kan het zien als "Zoeken op Google naar...". Deze navigaties verschillen van getypte navigaties, omdat de gebruiker de bestemmings-URL niet heeft getypt of gezien. Ze zijn ook gerelateerd aan trefwoordnavigatie.

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

"formulier_verzenden"
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 knop 'Vernieuwen' te klikken of door op Enter in de adresbalk te drukken. Sessieherstel en Gesloten tabblad heropenen 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 dat is gegenereerd voor een trefwoord.

UrlDetails

Chroom 88+

Eigenschappen

  • url

    snaar

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

VisitItem

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

Eigenschappen

  • id

    snaar

    De unieke identificatie voor de bijbehorende history.HistoryItem .

  • isLokaal

    Booleaanse

    Chroom 115+

    True als het bezoek op dit apparaat is gestart. False als het vanaf een ander apparaat is gesynchroniseerd.

  • verwijzendeBezoekID

    snaar

    Het bezoek-ID van de verwijzer.

  • overgang

    Het overgangstype voor dit bezoek vanaf de verwijzende partij.

  • bezoek-ID

    snaar

    De unieke identificatie voor dit bezoek.

  • bezoekTijd

    nummer optioneel

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

Methoden

addUrl()

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

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

Parameters

Retourneren

  • Belofte<leegte>

    Chroom 96+

deleteAll()

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

Verwijdert alle items uit de geschiedenis.

Retourneren

  • Belofte<leegte>

    Chroom 96+

deleteRange()

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

Verwijdert alle items binnen het opgegeven datumbereik uit de geschiedenis. Pagina's worden pas uit de geschiedenis verwijderd als 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.

Retourneren

  • Belofte<leegte>

    Chroom 96+

deleteUrl()

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

Verwijdert alle exemplaren van de opgegeven URL uit de geschiedenis.

Parameters

Retourneren

  • Belofte<leegte>

    Chroom 96+

getVisits()

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

Haalt informatie op over bezoeken aan een URL.

Parameters

Retourneren

chrome.history.search(
  query: object,
)
: Promise<HistoryItem[]>

Doorzoekt de geschiedenis van elke pagina die aan de zoekopdracht voldoet op de laatste bezoektijd.

Parameters

  • vraag

    voorwerp

    • eindtijd

      nummer optioneel

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

    • maxResultaten

      nummer optioneel

      Het maximale aantal op te halen resultaten. Standaard is dit 100.

    • starttijd

      nummer optioneel

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

    • tekst

      snaar

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

Retourneren

Evenementen

onVisited

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

Wordt geactiveerd wanneer een URL wordt bezocht en levert de HistoryItem gegevens voor die URL. 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 ziet er als volgt uit:

    (removed: object) => void

    • VERWIJDERD

      voorwerp

      • allHistory

        Booleaanse

        True als alle geschiedenis is verwijderd. Indien true, zijn de URL's leeg.

      • URL's

        string[] optioneel