Classe google.script.history (API côté client)

google.script.history est une API JavaScript côté client asynchrone qui peut interagir avec la pile d'historique du navigateur. Il ne peut être utilisé que dans le contexte d'une application Web qui utilise IFRAME Elle n'est pas destinée à être utilisée avec les barres latérales et les boîtes de dialogue d'un module complémentaire ou conteneur-script. Pour en savoir plus, consultez les guide d'utilisation du navigateur dans les applications Web.

Méthodes

MéthodeType renvoyéBrève description
push(stateObject, params, hash) void Transfère l'objet d'état, les paramètres d'URL et le fragment d'URL fournis à l'historique du navigateur. pile.
replace(stateObject, params, hash) void Remplace l'événement principal de la pile de l'historique du navigateur par l'objet d'état fourni (URL). et le fragment d'URL.
setChangeHandler(function) void Définit une fonction de rappel pour répondre aux modifications apportées à l'historique du navigateur

Documentation détaillée

push(stateObject, params, hash)

Transfère l'objet d'état, les paramètres d'URL et le fragment d'URL fournis à l'historique du navigateur. pile. L'objet état est un objet JavaScript simple défini par le développeur et pouvant ne contiennent aucune donnée pertinente pour l'état actuel de l'application. Cette méthode est analogue à la méthode pushState() JavaScript.

Index.html

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

Paramètres

NomTypeDescription
stateObjectObjectUn objet défini par le développeur à associé à un événement d'historique de navigateur et qui réapparaît lorsque l'état est renvoyé. Habituellement utilisées pour stocker des informations sur l'état de l'application (telles que les données de page) en vue de leur récupération ultérieure.
paramsObjectUn objet contenant des paramètres d'URL pour associer à cet état. Par exemple, {foo: “bar”, fiz: “baz”} équivaut à "?foo=bar&fiz=baz" Vous pouvez également utiliser des tableaux: {foo: [“bar”, “cat”], fiz: “baz”} équivaut à "?foo=bar&foo=cat&fiz=baz". Si la valeur est nulle ou non définie, les paramètres d'URL actuels ne sont pas modifiés. Si ce champ n'est pas renseigné, les paramètres d'URL sont effacés.
hashStringLe fragment d'URL de chaîne apparaissant après le "#" . S'il est nul ou non défini, le fragment d'URL actuel n'est pas modifié. Si ce champ est vide, Le fragment d'URL est effacé.

replace(stateObject, params, hash)

Remplace l'événement principal de la pile de l'historique du navigateur par l'état fourni (défini par le développeur). les paramètres d'URL et le fragment d'URL. Par ailleurs, il est identique à push().

Index.html

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

Paramètres

NomTypeDescription
stateObjectObjectUn objet défini par le développeur à associé à un événement d'historique de navigateur et qui réapparaît lorsque l'état est renvoyé. Habituellement utilisées pour stocker des informations sur l'état de l'application (telles que les données de page) en vue de leur récupération ultérieure.
paramsObjectUn objet contenant des paramètres d'URL pour associer à cet état. Par exemple, {foo: “bar”, fiz: “baz”} équivaut à "?foo=bar&fiz=baz" Vous pouvez également utiliser des tableaux: {foo: [“bar”, “cat”], fiz: “baz”} équivaut à "?foo=bar&foo=cat&fiz=baz". Si la valeur est nulle ou non définie, les paramètres d'URL actuels ne sont pas modifiés. Si ce champ n'est pas renseigné, les paramètres d'URL sont effacés.
hashStringLe fragment d'URL de chaîne apparaissant après le "#" . S'il est nul ou non défini, le fragment d'URL actuel n'est pas modifié. Si ce champ est vide, Le fragment d'URL est effacé.

setChangeHandler(function)

Définit une fonction de rappel pour répondre aux modifications apportées à l'historique du navigateur. La fonction de rappel ne doit utiliser qu'un seul objet événement comme argument.

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...
});

Paramètres

NomTypeDescription
functionFunctioncôté client de rappel à exécuter lors d'un événement de modification de l'historique, à l'aide de la méthode event comme seul argument.

Objet événement

Champs
e.state

Objet état associé à l'événement transmis. Cet objet est identique à l'état utilisé dans la fonction push() correspondante replace() qui a ajouté l'état d'affichage. à la pile "Historique".

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

Un objet de localisation associé à l'événement renvoyé

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