Dokumentácia / Integrácie a tvorba obsahu / Ovládanie vrstiev systému z vašej webovej stránky

Ovládanie vrstiev systému z vašej webovej stránky

Úvod a orientácia

Ako prepojiť vlastné tlačidlá vo vašej webovej stránke s navigáciou medzi vrstvami systému.

Kedy tieto funkcie použiť

Tieto funkcie JavaScriptu sú dostupné vašej webovej stránke otvorenej na zariadení prostredníctvom aplikácie Webová stránka. Vývojár vášho webu — alebo vy sami, ak web vyvíjate — ich môže prepojiť s vlastnými tlačidlami priamo na stránke a umožniť návštevníkom otvoriť ponuku aplikácií alebo prejsť k prehrávaniu kampaní.

Táto možnosť je vhodná, ak chcete web zobrazovať cez celý displej bez systémových ovládacích prvkov a navigáciu medzi vrstvami začleniť do vlastného dizajnu. V ukážke je predvolenou aplikáciou mapa a vedľa nej ponuka ďalších aplikácií.

Vlastné tlačidlá vo vloženom webe

1 — Menu: vlastné tlačidlo webu otvorí ponuku aplikácií v aplikačnej vrstve. Návštevník tak môže z mapy prejsť k ďalším aplikáciám. showLayerBottom

2 — Reklama: vlastné tlačidlo webu prepne do prezentačnej vrstvy s kampaňami. showLayerTop

Názvy a vzhľad tlačidiel sú iba príklad. Do vloženého webu ich zapracuje jeho vývojár alebo dodávateľ. Zapojenie tlačidiel opisujú navigačné funkcie a ukážky kódu nižšie.

Prechod do ponuky vyžaduje viac než jednu práve dostupnú aplikáciu; prechod do reklamy vyžaduje zapnutú prezentačnú vrstvu. Konkrétnu návratovú cestu vždy overte na cieľovom zariadení.

Komu je návod určený a kto čo zabezpečuje

  • Poskytovateľ platformy zabezpečuje navigačné funkcie prehrávača a dokumentáciu ich použitia.
  • Zákazník vyberá web zobrazovaný v aplikácii Webová stránka a s jeho poskytovateľom dohodne požadované ovládanie.
  • Poskytovateľ alebo vývojár vloženého webu upravuje samotný web — napríklad pridá tlačidlá a napojí ich na opísané funkcie. Technické pokyny a ukážky kódu v tomto návode sú určené práve jemu. Ak web vyvíjate sami, túto rolu zastávate vy.

Technická dokumentácia

Technická časť pre vývojárov webovej stránky

Prepojte vlastné tlačidlá s navigačnými funkciami systému. Najprv sa oboznámte so spoločnými pravidlami volania, potom s jednotlivými funkciami a ukážkami kódu.

Funkcie poskytuje prehrávač webu otvorenému v aplikácii webová stránka. Pred použitím overte ich dostupnosť, ako ukazujú príklady nižšie.

Spoločné pravidlá volania

  • Požiadavka: request je reťazec obsahujúci prázdny objekt JSON. Používajte request: '{}', nie priamo objekt {}.
  • Úspech: onSuccess potvrdzuje prijatie požiadavky, nie dokončenie prechodu alebo zobrazenie konkrétnej kampane. Odpoveď neobsahuje aplikačné dáta; na hodnote response nestavajte rozhodovanie.
  • Chyba: obslúžte onFailure(error_code, error_message). Pri nižšie uvedených zamietnutých požiadavkách je kód -1. Chybové správy sú doslovné hodnoty rozhrania a neprekladajú sa.

onUp

Vyvolá návrat v navigácii systému. Cieľ závisí od režimu webovej aplikácie a dostupnej navigačnej cesty. Nejde o návrat na predchádzajúcu URL v histórii webu; funkcia nie je ekvivalentom window.history.back(). Ak návrat nie je dostupný, vráti chybu uvedenú nižšie.

if (typeof window.onUp !== 'function') {
    console.warn("Navigačná funkcia prehrávača nie je dostupná.");
} else {
    window.onUp({
        request: '{}',
        onSuccess: function () {
            console.log("Navigačná požiadavka bola prijatá.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

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

showLayerBottom

Vyžiada prechod do ponuky aplikačnej vrstvy. Vyžaduje viac než jednu aktuálne dostupnú položku v zozname aplikácií a zohľadňuje ich naplánovanú platnosť. Pri jedinej dostupnej položke alebo bez dostupných položiek vráti chybu uvedenú nižšie.

if (typeof window.showLayerBottom !== 'function') {
    console.warn("Navigačná funkcia prehrávača nie je dostupná.");
} else {
    window.showLayerBottom({
        request: '{}',
        onSuccess: function () {
            console.log("Navigačná požiadavka bola prijatá.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Chyba: error_code -1, Single-app kiosk.

showLayerTop

Vyžiada prechod do prezentačnej vrstvy. Tá musí byť v konfigurácii zariadenia zapnutá; inak funkcia vráti chybu uvedenú nižšie. Prijatie požiadavky samo osebe nepotvrdzuje prehratie konkrétnej kampane ani dostupnosť jej obsahu.

if (typeof window.showLayerTop !== 'function') {
    console.warn("Navigačná funkcia prehrávača nie je dostupná.");
} else {
    window.showLayerTop({
        request: '{}',
        onSuccess: function () {
            console.log("Navigačná požiadavka bola prijatá.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Chyba: error_code -1, Top layer disabled.

Odporúčania pre implementáciu

Použite onUp na návrat podľa kontextu, showLayerBottom na ponuku aplikácií a showLayerTop na prezentačný obsah. Zabráňte opakovaným rýchlym volaniam, napríklad viacnásobnému stlačeniu tlačidla. Neexistujúca funkcia vyvolá chybu JavaScriptu ešte pred zavolaním onFailure; preto príklady najprv kontrolujú jej dostupnosť.

Nenašli ste, čo ste hľadali?
Obráťte sa na svojho poskytovateľa softvéru.