Dokumentace / Integrace a tvorba obsahu / Ovládání vrstev systému z vaší webové stránky

Ovládání vrstev systému z vaší webové stránky

Úvod a orientace

Jak propojit vlastní tlačítka ve vaší webové stránce s navigací mezi vrstvami systému.

Kdy tyto funkce použít

Tyto JavaScriptové funkce jsou dostupné vaší webové stránce otevřené na zařízení prostřednictvím aplikace webová stránka. Vývojář vašeho webu — nebo vy sami, pokud web vyvíjíte — je může propojit s vlastními tlačítky přímo ve stránce a umožnit návštěvníkům otevřít nabídku aplikací nebo přejít k přehrávání kampaní.

Tato možnost se hodí, pokud chcete web zobrazovat přes celý displej bez systémových ovládacích prvků a navigaci mezi vrstvami začlenit do vlastního designu. V ukázce je výchozí aplikací mapa a vedle ní nabídka dalších aplikací.

Vlastní tlačítka ve vloženém webu

1 — Menu: vlastní tlačítko webu otevře nabídku aplikací v aplikační vrstvě. Návštěvník tak může z mapy přejít k dalším aplikacím. showLayerBottom

2 — Reklama: vlastní tlačítko webu přepne do prezentační vrstvy s kampaněmi. showLayerTop

Názvy a vzhled tlačítek jsou pouze příklad. Do vloženého webu je zapracuje jeho vývojář nebo dodavatel. Zapojení tlačítek popisují navigační funkce a ukázky kódu níže.

Přechod do nabídky vyžaduje více než jednu právě dostupnou aplikaci; přechod do reklamy vyžaduje zapnutou prezentační vrstvu. Konkrétní návratovou cestu vždy ověřte na cílovém zařízení.

Komu je návod určen a kdo co zajišťuje

  • Poskytovatel platformy zajišťuje navigační funkce přehrávače a dokumentaci jejich použití.
  • Zákazník vybírá web zobrazovaný v aplikaci Webová stránka a s jeho poskytovatelem domlouvá požadované ovládání.
  • Poskytovatel nebo vývojář vloženého webu upravuje samotný web — například přidá tlačítka a napojí je na popsané funkce. Technické pokyny a ukázky kódu v tomto návodu jsou určeny právě jemu. Pokud web vyvíjíte sami, tuto roli zastáváte vy.

Technická dokumentace

Technická část pro vývojáře webové stránky

Propojte vlastní tlačítka s navigačními funkcemi systému. Nejprve se seznamte se společnými pravidly volání, poté s jednotlivými funkcemi a ukázkami kódu.

Funkce poskytuje přehrávač webu otevřenému v aplikaci webová stránka. Před jejich použitím ověřte dostupnost, jak ukazují příklady níže.

Společná pravidla volání

  • Požadavek: request je řetězec obsahující prázdný JSON objekt. Používejte request: '{}', nikoli přímo objekt {}.
  • Úspěch: onSuccess potvrzuje přijetí požadavku, nikoli dokončení přechodu nebo zobrazení konkrétní kampaně. Odpověď neobsahuje aplikační data; na hodnotě response nestavte rozhodování.
  • Chyba: obslužte onFailure(error_code, error_message). U níže uvedených zamítnutých požadavků je kód -1. Chybové zprávy jsou doslovné hodnoty rozhraní a nepřekládají se.

onUp

Vyvolá návrat v navigaci systému. Cíl závisí na režimu webové aplikace a dostupné navigační cestě. Nejde o návrat na předchozí URL v historii webu; funkce není ekvivalentem window.history.back(). Pokud návrat není dostupný, vrátí chybu uvedenou níže.

if (typeof window.onUp !== 'function') {
    console.warn("Navigační funkce přehrávače není dostupná.");
} else {
    window.onUp({
        request: '{}',
        onSuccess: function () {
            console.log("Navigační požadavek byl přijat.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Chyba: error_code -1, Disabled bottom layer. Single-app kiosk.

showLayerBottom

Vyžádá přechod do nabídky aplikační vrstvy. Vyžaduje více než jednu aktuálně dostupnou položku v seznamu aplikací a zohledňuje jejich naplánovanou platnost. Při jediné dostupné položce nebo bez dostupných položek vrátí chybu uvedenou níže.

if (typeof window.showLayerBottom !== 'function') {
    console.warn("Navigační funkce přehrávače není dostupná.");
} else {
    window.showLayerBottom({
        request: '{}',
        onSuccess: function () {
            console.log("Navigační požadavek byl přijat.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Chyba: error_code -1, Single-app kiosk.

showLayerTop

Vyžádá přechod do prezentační vrstvy. Ta musí být v konfiguraci zařízení zapnutá; jinak funkce vrátí chybu uvedenou níže. Přijetí požadavku samo o sobě nepotvrzuje přehrání konkrétní kampaně ani dostupnost jejího obsahu.

if (typeof window.showLayerTop !== 'function') {
    console.warn("Navigační funkce přehrávače není dostupná.");
} else {
    window.showLayerTop({
        request: '{}',
        onSuccess: function () {
            console.log("Navigační požadavek byl přijat.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Chyba: error_code -1, Top layer disabled.

Doporučení pro implementaci

Použijte onUp pro návrat podle kontextu, showLayerBottom pro nabídku aplikací a showLayerTop pro prezentační obsah. Zabraňte opakovaným rychlým voláním, například několikanásobnému stisknutí tlačítka. Neexistující funkce vyvolá chybu JavaScriptu ještě před zavoláním onFailure; proto příklady nejprve kontrolují její dostupnost.

Nenašli jste, co jste hledali?
Obraťte se na svého poskytovatele softwaru.