browser.history

Descrizione

Utilizza l'API chrome.history per interagire con il record delle pagine visitate del browser. Puoi aggiungere, rimuovere ed eseguire query sugli URL nella cronologia del browser. Per sostituire la pagina della cronologia con la tua versione, consulta Override Pages.

Autorizzazioni

history

Per interagire con la cronologia di navigazione dell'utente, utilizza l'API History.

Per utilizzare l'API History, dichiara l'autorizzazione "history" nel manifest dell'estensione. Ad esempio:

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

Concetti e utilizzo

Tipi di transizione

L'API History utilizza i tipi di transizione per descrivere in che modo il browser ha raggiunto un determinato URL durante una determinata visita. Ad esempio, se un utente visita una pagina facendo clic su un link in un'altra pagina, il tipo di transizione è "link". Consulta i contenuti di riferimento per un elenco dei tipi di transizione.

Esempi

Per provare questa API, installa l'esempio di API History dal repository chrome-extension-samples.

Tipi

HistoryItem

Un oggetto che incapsula un risultato di una query sulla cronologia.

Proprietà

  • id

    stringa

    L'identificatore univoco dell'elemento.

  • lastVisitTime

    number optional

    L'ultimo caricamento di questa pagina, rappresentato in millisecondi dall'epoch.

  • titolo

    stringa facoltativa

    Il titolo della pagina al momento dell'ultimo caricamento.

  • typedCount

    number optional

    Il numero di volte in cui l'utente ha visitato questa pagina digitando l'indirizzo.

  • url

    stringa facoltativa

    L'URL a cui l'utente ha eseguito la navigazione.

  • visitCount

    number optional

    Il numero di volte in cui l'utente ha visitato questa pagina.

TransitionType

Browser Chrome 44 e versioni successive * da Chrome 148

Il tipo di transizione per questa visita dal relativo referrer.

Enum

"link"
L'utente è arrivato a questa pagina facendo clic su un link in un'altra pagina.

"typed"
L'utente è arrivato a questa pagina digitando l'URL nella barra degli indirizzi. Questo viene utilizzato anche per altre azioni di navigazione esplicite.

"auto_bookmark"
L'utente è arrivato a questa pagina tramite un suggerimento nell'interfaccia utente, ad esempio tramite una voce di menu.

"auto_subframe"
L'utente è arrivato a questa pagina tramite la navigazione in un subframe che non ha richiesto, ad esempio tramite il caricamento degli annunci in un frame della pagina precedente. Questi non generano sempre nuove voci di navigazione nei menu Indietro e Avanti.

"manual_subframe"
L'utente è arrivato a questa pagina selezionando un elemento in un frame secondario.

"generated"
L'utente è arrivato a questa pagina digitando nella barra degli indirizzi e selezionando una voce che non sembrava un URL, ad esempio un suggerimento di Ricerca Google. Ad esempio, una corrispondenza potrebbe avere l'URL di una pagina dei risultati di ricerca di Google, ma potrebbe essere visualizzata dall'utente come "Cerca su Google…". Queste navigazioni sono diverse da quelle digitate perché l'utente non ha digitato o visualizzato l'URL di destinazione. Sono anche correlate alla navigazione per parole chiave.

"auto_toplevel"
La pagina è stata specificata nella riga di comando o è la pagina iniziale.

"form_submit"
L'utente è arrivato a questa pagina compilando i valori in un modulo e inviandolo. Non tutti gli invii di moduli utilizzano questo tipo di transizione.

"reload"
L'utente ha ricaricato la pagina facendo clic sul pulsante di ricaricamento o premendo Invio nella barra degli indirizzi. Anche il ripristino della sessione e la riapertura della scheda chiusa utilizzano questo tipo di transizione.

"keyword"
L'URL di questa pagina è stato generato da una parola chiave sostituibile diversa dal motore di ricerca predefinito.

"keyword_generated"
Corrisponde a una visita generata per una parola chiave.

UrlDetails

Chrome 88+ browser.* da Chrome 148

Proprietà

  • url

    stringa

    L'URL dell'operazione. Deve essere nel formato restituito da una chiamata a history.search().

VisitItem

Un oggetto che incapsula una visita a un URL.

Proprietà

  • id

    stringa

    L'identificatore univoco del history.HistoryItem corrispondente.

  • isLocal

    booleano

    Chrome 115 e versioni successive browser.* da Chrome 148

    True se la visita ha avuto origine su questo dispositivo. False se è stato sincronizzato da un altro dispositivo.

  • referringVisitId

    stringa

    L'ID visita del referrer.

  • transizione

    TransitionType

    Il tipo di transizione per questa visita dal relativo referrer.

  • visitId

    stringa

    L'identificatore univoco della visita.

  • visitTime

    number optional

    Quando si è verificata questa visita, rappresentata in millisecondi dall'epoca.

Metodi

addUrl()

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

Aggiunge un URL alla cronologia all'ora corrente con un tipo di transizione "link".

Parametri

Resi

  • Promise<void>

    Browser Chrome 96+ .* da Chrome 148

deleteAll()

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

Elimina tutti gli elementi dalla cronologia.

Resi

  • Promise<void>

    Browser Chrome 96+ .* da Chrome 148

deleteRange()

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

Rimuove dalla cronologia tutti gli elementi compresi nell'intervallo di date specificato. Le pagine non verranno rimosse dalla cronologia, a meno che tutte le visite non rientrino nell'intervallo.

Parametri

  • gamma

    oggetto

    • endTime

      numero

      Elementi aggiunti alla cronologia prima di questa data, rappresentati in millisecondi dall'epoca.

    • startTime

      numero

      Elementi aggiunti alla cronologia dopo questa data, rappresentati in millisecondi dall'epoca.

Resi

  • Promise<void>

    Browser Chrome 96+ .* da Chrome 148

deleteUrl()

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

Rimuove tutte le occorrenze dell'URL specificato dalla cronologia.

Parametri

Resi

  • Promise<void>

    Browser Chrome 96+ .* da Chrome 148

getVisits()

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

Recupera le informazioni sulle visite a un URL.

Parametri

Resi

  • Promise<VisitItem[]>

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

Cerca nella cronologia l'ora dell'ultima visita di ogni pagina corrispondente alla query.

Parametri

  • query

    oggetto

    • endTime

      number optional

      Limita i risultati a quelli visitati prima di questa data, rappresentata in millisecondi dall'epoca.

    • maxResults

      number optional

      Il numero massimo di risultati da recuperare. Il valore predefinito è 100.

    • startTime

      number optional

      Limita i risultati a quelli visitati dopo questa data, rappresentata in millisecondi dall'epoca. Se la proprietà non viene specificata, il valore predefinito è 24 ore.

    • testo

      stringa

      Una query in formato libero al servizio di cronologia. Lascia vuoto questo campo per recuperare tutte le pagine.

Resi

  • Promise<HistoryItem[]>

    Browser Chrome 96+ .* da Chrome 148

Eventi

onVisited

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

Attivato quando viene visitato un URL, fornendo i dati HistoryItem per quell'URL. Questo evento viene attivato prima del caricamento della pagina.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (result: HistoryItem) => void

onVisitRemoved

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

Attivato quando uno o più URL vengono rimossi dalla cronologia. Quando tutte le visite sono state rimosse, l'URL viene eliminato dalla cronologia.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (removed: object) => void

    • rimosso

      oggetto

      • allHistory

        booleano

        True se tutta la cronologia è stata rimossa. Se è true, gli URL saranno vuoti.

      • Url

        string[] facoltativo