google.script.history
to asynchroniczny interfejs API JavaScript działający po stronie klienta, który może współdziałać
dzięki stosowi historii przeglądania. Można go używać tylko w kontekście aplikacji internetowej, która używa
IFRAME
Nie należy go używać z paskami bocznymi i oknami w dodatku ani
container-script. Więcej informacji:
przewodnik po korzystaniu z przeglądarki
historię w aplikacjach internetowych.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
push(stateObject, params, hash) |
void |
Przekazuje do historii przeglądarki podany obiekt stanu, parametry adresu URL i fragment adresu URL stosów. |
replace(stateObject, params, hash) |
void |
Zastępuje główne zdarzenie w stosie historii przeglądarki podanym obiektem stanu, adresem URL parametrów i fragmentu adresu URL. |
setChangeHandler(function) |
void |
Ustawia funkcję wywołania zwrotnego w celu reagowania na zmiany w historii przeglądarki |
Szczegółowa dokumentacja
push(stateObject, params, hash)
Przekazuje do historii przeglądarki podany obiekt stanu, parametry adresu URL i fragment adresu URL stosów. Obiekt stanu to prosty obiekt JavaScript zdefiniowany przez programistę zawierają wszystkie dane związane z bieżącym stanem aplikacji. Ta metoda jest analogiczna do pushState() Metoda JavaScript.
Index.html
var now = new Date(); var state = { 'timestamp': now.getTime() }; var params = { 'options': "none" }; google.script.history.push(state, params, "anchor1");
Parametry
Nazwa | Typ | Opis |
---|---|---|
stateObject | Object | Obiekt zdefiniowany przez programistę, który ma zostać powiązane ze zdarzeniem historii przeglądania i pojawiają się ponownie po wyszukaniu stanu. Zwykle służą do przechowywania informacji o stanie aplikacji (np. danych strony) w celu ich późniejszego pobrania. |
params | Object | Obiekt zawierający parametry adresu URL do
z tym stanem. Na przykład {foo: “bar”, fiz: “baz”} oznacza
"?foo=bar&fiz=baz" Można też użyć tablic:
{foo: [“bar”, “cat”], fiz: “baz”} odpowiada "?foo=bar&foo=cat&fiz=baz" .
Jeśli ma wartość null lub nie jest określona, bieżące parametry adresu URL nie ulegają zmianie. Jeśli pole jest puste, parametry adresu URL mają postać
wyczyszczono.
|
hash | String | Fragment adresu URL ciągu widoczny po znak „#” znaku. Jeśli ma wartość null lub nie jest zdefiniowany, bieżący fragment adresu URL nie zostaje zmieniony. Jeśli pole jest puste, Fragment adresu URL został wyczyszczony. |
replace(stateObject, params, hash)
Zastępuje główne zdarzenie w stosie historii przeglądania stanem podanym (zdefiniowanym przez dewelopera) , parametry adresu URL i fragment adresu URL. Pod innymi względami jest ona taka sama jak push().
Index.html
var now = new Date(); var state = { 'timestamp': now.getTime() }; var params = { 'options': "none" }; google.script.history.replace(state, params, "anchor1");
Parametry
Nazwa | Typ | Opis |
---|---|---|
stateObject | Object | Obiekt zdefiniowany przez programistę, który ma zostać powiązane ze zdarzeniem historii przeglądania i pojawiają się ponownie po wyszukaniu stanu. Zwykle służą do przechowywania informacji o stanie aplikacji (np. danych strony) w celu ich późniejszego pobrania. |
params | Object | Obiekt zawierający parametry adresu URL do
z tym stanem. Na przykład {foo: “bar”, fiz: “baz”} oznacza
"?foo=bar&fiz=baz" Można też użyć tablic:
{foo: [“bar”, “cat”], fiz: “baz”} odpowiada "?foo=bar&foo=cat&fiz=baz" .
Jeśli ma wartość null lub nie jest określona, bieżące parametry adresu URL nie ulegają zmianie. Jeśli pole jest puste, parametry adresu URL mają postać
wyczyszczono.
|
hash | String | Fragment adresu URL ciągu widoczny po znak „#” znaku. Jeśli ma wartość null lub nie jest zdefiniowany, bieżący fragment adresu URL nie zostaje zmieniony. Jeśli pole jest puste, Fragment adresu URL został wyczyszczony. |
setChangeHandler(function)
Ustawia funkcję wywołania zwrotnego w celu reagowania na zmiany w historii przeglądarki. Funkcja wywołania zwrotnego powinien przyjmować tylko jeden obiekt zdarzenia jako 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... });
Parametry
Nazwa | Typ | Opis |
---|---|---|
function | Function | po stronie klienta wywołania zwrotnego, która ma być uruchamiana po zdarzeniu zmiany w historii, korzystając z funkcji eventobject (obiekt event) jako jedynego argumentu. |
Obiekt zdarzenia
Pola | |
---|---|
e.state |
Obiekt stanu powiązany ze zdarzeniem wyskakującym. Ten obiekt jest identyczny ze stanem używany w odpowiedniej funkcji push() lub metoda replace(), która dodała stan wyskakujący. do stosu historii. {"page":2, "name":"Wilbur"} |
e.location |
obiekt lokalizacji. powiązane z wyskakującym zdarzeniem {"hash":"", "parameter":{"name": "alice", "n": "1"}, "parameters":{"name": ["alice"], "n": ["1", "2"]}} |