Clase google.script.history (API del cliente)

google.script.history es una API de JavaScript asíncrona del cliente que puede interactuar. con la pila del historial del navegador. Solo se puede usar en el contexto de una aplicación web que use IFRAME No está diseñado para usarse con barras laterales y diálogos en un complemento o contexto de secuencia de comandos del contenedor. Para obtener más información, consulta la guía para usar el navegador en apps web.

Métodos

MétodoTipo de datos que se muestraDescripción breve
push(stateObject, params, hash) void Envía el objeto de estado proporcionado, los parámetros y el fragmento de URL al historial del navegador. en una pila.
replace(stateObject, params, hash) void Reemplaza el evento superior en la pila del historial del navegador con el objeto de estado proporcionado, URL parámetros y fragmento de URL.
setChangeHandler(function) void Establece una función de devolución de llamada para responder a los cambios en el historial del navegador.

Documentación detallada

push(stateObject, params, hash)

Envía el objeto de estado proporcionado, los parámetros y el fragmento de URL al historial del navegador. en una pila. El objeto de estado es un objeto simple de JavaScript definido por el desarrollador y puede contener todos los datos relevantes para el estado actual de la aplicación. Este método es análogo al método pushState() Método de JavaScript.

Index.html

var now = new Date();
var state = {
  'timestamp': now.getTime()
};
var params = {
  'options': "none"
};
google.script.history.push(state, params, "anchor1");

Parámetros

NombreTipoDescripción
stateObjectObjectUn objeto definido por el desarrollador que se asociados con un evento del historial del navegador y que vuelve a aparecer cuando se abre el estado. Precio habitual Se usan para almacenar información del estado de la aplicación (como datos de páginas) y recuperarse en el futuro.
paramsObjectUn objeto que contiene los parámetros de URL para asociar con este estado. Por ejemplo, {foo: “bar”, fiz: “baz”} equivale a "?foo=bar&fiz=baz" Como alternativa, se pueden usar arrays: {foo: [“bar”, “cat”], fiz: “baz”} equivale a "?foo=bar&foo=cat&fiz=baz". Si es nulo o no está definido, no se cambian los parámetros actuales de la URL. Si están vacíos, los parámetros de URL se borrar.
hashStringEl fragmento de URL de cadena que aparece después el carácter. Si es nulo o indefinido, el fragmento de URL actual no se cambia. Si está vacía, el Se borró el fragmento de URL.

replace(stateObject, params, hash)

Reemplaza el evento superior en la pila del historial de navegación con el estado proporcionado (definido por el desarrollador) objeto, los parámetros de URL y el fragmento de URL. Esto es igual a push().

Index.html

var now = new Date();
var state = {
  'timestamp': now.getTime()
};
var params = {
  'options': "none"
};
google.script.history.replace(state, params, "anchor1");

Parámetros

NombreTipoDescripción
stateObjectObjectUn objeto definido por el desarrollador que se asociados con un evento del historial del navegador y que vuelve a aparecer cuando se abre el estado. Precio habitual Se usan para almacenar información del estado de la aplicación (como datos de páginas) y recuperarse en el futuro.
paramsObjectUn objeto que contiene los parámetros de URL para asociar con este estado. Por ejemplo, {foo: “bar”, fiz: “baz”} equivale a "?foo=bar&fiz=baz" Como alternativa, se pueden usar arrays: {foo: [“bar”, “cat”], fiz: “baz”} equivale a "?foo=bar&foo=cat&fiz=baz". Si es nulo o no está definido, no se cambian los parámetros actuales de la URL. Si están vacíos, los parámetros de URL se borrar.
hashStringEl fragmento de URL de cadena que aparece después el carácter. Si es nulo o indefinido, el fragmento de URL actual no se cambia. Si está vacía, el Se borró el fragmento de URL.

setChangeHandler(function)

Establece una función de devolución de llamada para responder a los cambios en el historial del navegador. La función de devolución de llamada debería tomar solo un objeto de evento único como argumento.

Index.html

google.script.history.setChangeHandler(function (e) {
  console.log(e.state);
  console.log(e.location.parameters);
  console.log(e.location.hash);

  // Adjust web app UI to match popped state here...
});

Parámetros

NombreTipoDescripción
functionFunctiondel cliente función de devolución de llamada para que se ejecute en un evento de cambio del historial mediante el event object como único argumento.

Objeto de evento

Campos
e.state

El objeto de estado asociado con el evento emergente. Este objeto es idéntico al estado que se usó en el método push() o replace() que agregó el estado emergente en la pila del historial.

{"page":2, "name":"Wilbur"}
e.location

Un objeto de ubicación asociado con el evento emergente

{"hash":"", "parameter":{"name": "alice", "n": "1"}, "parameters":{"name": ["alice"], "n": ["1", "2"]}}