Descripción
Usa la API de chrome.history para interactuar con el registro de páginas visitadas del navegador. Puedes agregar, quitar y consultar URLs en el historial del navegador. Para anular la página de historial con tu propia versión, consulta Anula páginas.
Permisos
historyPara interactuar con el historial de navegación del usuario, usa la API de History.
Para usar la API de historial, declara el permiso "history" en el manifiesto de la extensión. Por ejemplo:
{
"name": "My extension",
...
"permissions": [
"history"
],
...
}
Conceptos y uso
Tipos de transiciones
La API de History usa tipos de transición para describir cómo el navegador navegó a una URL específica en una visita determinada. Por ejemplo, si un usuario visita una página haciendo clic en un vínculo de otra página, el tipo de transición es "link". Consulta el contenido de referencia para obtener una lista de los tipos de transición.
Ejemplos
Para probar esta API, instala el ejemplo de la API de historial del repositorio chrome-extension-samples.
Tipos
HistoryItem
Es un objeto que encapsula un resultado de una consulta del historial.
Propiedades
-
id
string
Es el identificador único del artículo.
-
lastVisitTime
number opcional
Indica cuándo se cargó esta página por última vez, expresado en milisegundos desde la época.
-
título
string opcional
Es el título de la página cuando se cargó por última vez.
-
typedCount
number opcional
Indica la cantidad de veces que el usuario navegó a esta página escribiendo la dirección.
-
url
string opcional
Es la URL a la que navegó un usuario.
-
visitCount
number opcional
Indica la cantidad de veces que el usuario navegó a esta página.
TransitionType
El tipo de transición de esta visita desde su referente.
Enum
"link"
El usuario llegó a esta página haciendo clic en un vínculo de otra página.
"typed"
El usuario llegó a esta página escribiendo la URL en la barra de direcciones. Esto también se usa para otras acciones de navegación explícitas.
"auto_bookmark"
El usuario llegó a esta página a través de una sugerencia en la IU, por ejemplo, a través de un elemento de menú.
"auto_subframe"
El usuario llegó a esta página a través de una navegación de submarco que no solicitó, como un anuncio que se carga en un marco de la página anterior. Estas no siempre generan entradas de navegación nuevas en los menús de retroceso y avance.
"manual_subframe"
El usuario llegó a esta página seleccionando algo en un submarco.
"generated"
El usuario llegó a esta página escribiendo en la barra de direcciones y seleccionando una entrada que no parecía una URL, como una sugerencia de la Búsqueda de Google. Por ejemplo, una coincidencia puede tener la URL de una página de resultados de la Búsqueda de Google, pero puede aparecerle al usuario como "Buscar en Google…". Estas son diferentes de las navegaciones escritas porque el usuario no escribió ni vio la URL de destino. También se relacionan con las navegaciones por palabras clave.
"auto_toplevel"
La página se especificó en la línea de comandos o es la página de inicio.
"form_submit"
El usuario llegó a esta página después de completar los valores de un formulario y enviarlo. No todos los envíos de formularios usan este tipo de transición.
"reload"
El usuario volvió a cargar la página, ya sea haciendo clic en el botón para volver a cargar o presionando Intro en la barra de direcciones. La restauración de la sesión y la reapertura de la pestaña cerrada también usan este tipo de transición.
"keyword"
La URL de esta página se generó a partir de una palabra clave reemplazable que no es la del proveedor de búsqueda predeterminado.
"keyword_generated"
Corresponde a una visita generada para una palabra clave.
UrlDetails
Propiedades
-
url
string
Es la URL de la operación. Debe tener el formato que se devuelve de una llamada a
history.search().
VisitItem
Es un objeto que encapsula una visita a una URL.
Propiedades
-
id
string
Es el identificador único del
history.HistoryItemcorrespondiente. -
isLocal
booleano
Chrome 115 y versiones posteriores browser.* desde Chrome 148Es verdadero si la visita se originó en este dispositivo. Es falso si se sincronizó desde otro dispositivo.
-
referringVisitId
string
Es el ID de visita de la URL de referencia.
-
transición
El tipo de transición de esta visita desde su referente.
-
visitId
string
Es el identificador único de esta visita.
-
visitTime
number opcional
Cuándo se produjo esta visita, representada en milisegundos desde la época.
Métodos
addUrl()
browser.history.addUrl(
details: UrlDetails,
): Promise<void>
Agrega una URL al historial en el momento actual con un tipo de transición de "vínculo".
Parámetros
-
detalles
Muestra
-
Promise<void>
Chrome 96 y versiones posteriores browser.* desde Chrome 148
deleteAll()
browser.history.deleteAll(): Promise<void>
Borra todos los elementos del historial.
Muestra
-
Promise<void>
Chrome 96 y versiones posteriores browser.* desde Chrome 148
deleteRange()
browser.history.deleteRange(
range: object,
): Promise<void>
Quita del historial todos los elementos que se encuentren dentro del período especificado. Las páginas no se quitarán del historial, a menos que todas las visitas se encuentren dentro del período.
Parámetros
-
rango
objeto
-
endTime
número
Son los elementos que se agregaron al historial antes de esta fecha, representados en milisegundos desde el ciclo de entrenamiento.
-
startTime
número
Son los elementos que se agregaron al historial después de esta fecha, representados en milisegundos desde el ciclo de entrenamiento.
-
Muestra
-
Promise<void>
Chrome 96 y versiones posteriores browser.* desde Chrome 148
deleteUrl()
browser.history.deleteUrl(
details: UrlDetails,
): Promise<void>
Quita todas las instancias de la URL proporcionada del historial.
Parámetros
-
detalles
Muestra
-
Promise<void>
Chrome 96 y versiones posteriores browser.* desde Chrome 148
getVisits()
browser.history.getVisits(
details: UrlDetails,
): Promise<VisitItem[]>
Recupera información sobre las visitas a una URL.
Parámetros
-
detalles
Muestra
-
Promise<VisitItem[]>
Chrome 96 y versiones posteriores browser.* desde Chrome 148
search()
browser.history.search(
query: object,
): Promise<HistoryItem[]>
Busca en el historial la hora de la última visita de cada página que coincida con la consulta.
Parámetros
-
consulta
objeto
-
endTime
number opcional
Limita los resultados a los que se visitaron antes de esta fecha, representada en milisegundos desde la época.
-
maxResults
number opcional
Es la cantidad máxima de resultados que se recuperarán. La configuración predeterminada es 100.
-
startTime
number opcional
Limita los resultados a los que se visitaron después de esta fecha, representada en milisegundos desde el ciclo de entrenamiento. Si no se especifica la propiedad, el valor predeterminado será de 24 horas.
-
texto
string
Es una consulta de texto libre al servicio de historial. Deja este campo vacío para recuperar todas las páginas.
-
Muestra
-
Promise<HistoryItem[]>
Chrome 96 y versiones posteriores browser.* desde Chrome 148
Eventos
onVisited
browser.history.onVisited.addListener(
callback: function,
)
Se activa cuando se visita una URL y proporciona los datos de HistoryItem para esa URL. Este evento se activa antes de que se cargue la página.
Parámetros
-
callback
función
El parámetro
callbackse ve de la siguiente manera:(result: HistoryItem) => void
-
resultado
-
onVisitRemoved
browser.history.onVisitRemoved.addListener(
callback: function,
)
Se activa cuando se quitan una o más URLs del historial. Cuando se quitan todas las visitas, la URL se borra del historial.
Parámetros
-
callback
función
El parámetro
callbackse ve de la siguiente manera:(removed: object) => void
-
quitado
objeto
-
allHistory
booleano
Es verdadero si se quitó todo el historial. Si es verdadero, las URLs estarán vacías.
-
url
string[] opcional
-
-