API metody Javascriptu
Po načtení Javascriptové knihovny, můžete volat následující API funkce, které vám dovolí s widgetem pracovat.
create(placement, config);
Metoda zapíše do dokumentu své HTML.
placement (null | string)
- Může být
null
. V takovém případě se Widget se svým HTML vloží na konec tagu<body>
. Jedná se o výchozí nastavení protype=popup
. - Jinak, vložte selector ve formátu
string
pro umístění widgetu (např.#msgokwidget
)
config (object)
- Nastavte jednotlivé klíče dle dokumentace.
show();
Dojde k zobrazení widgetu: vykreslí se inline
samoobslua nebo se zobrazí nerozkliknutý popup
widget (tj. ikona, nebo tlačítko typicky vpravo dole).
modifyPayload(payload, open);
payload (string)
- Vložte nový payload, který se má ve widgetu zobrazit. Zároveň po nastavení dojde k zobrazení widgetu.
open (bool, default true)
- Pokud je nastaveno na
false
, widget se po změně payloadu nezobrazí (pokud již není zobrazen).
setVariable(key, name)
Dojde k nastavení (přidání) parametru do session uživatele. Takový parametr lze číst ve scénářích.
key (string)
- klíč (název proměnné, který ve scénáři budete používat jako
{{nazev}}
)
name (string)
- hodnota parametru (proměnné)