Sprievodca - API

Widget

Dotazník je zobrazený ako widget na spodku webovej stránky.

Môže obsahovať len jednu otázku (celá štúdia sa vykonáva pomocou miniaplikácie) alebo niekoľko otázok (iba prvá otázka je prezentovaná vo widgetu, zatiaľ čo ostatné otázky budú otvorené v novej záložke alebo na vrstve na navštívenej webovej stránke). Nepostrádateľná forma štúdia pre majiteľov webových stránok, ktorí chcú zbierať názory na svojich webových stránkach.

Popis možných konfigurácií widgetu

Názov Popis Možné hodnoty
title Nadpis hlavičky widgetu
titleColor Farba hlavičky widgetu Každá farba v  hexadomicálnomzápise
Východisková farba: #6AA84F
position Pozícia widgetu v okne prehliadača left – ľavý spodný roh
right – pravý spodný roh
width Šířka widgetu v pixeloch
height Výška widgetu v pixeloch
initState Nastaví počiatočného stavu widgetu hidden – skrytý
sample – minimalizovaný
open – otvorený
disableAfterFill Určuje, či bude widget skrytý po vyplnení dotazníka true or false
disableAfterClose Určuje, či bude widget skrytý po kliknutí na X true or false
capping Určuje, po koľkých zobrazeniach sa widget už nezobrazí. Hodnota 0 znamená, že sa widget bude zobrazovať neustále.
url Adresa dotazníka
surveyID ID dotazníku

Funkcie pre vyvolanie

Funkcia môže byť vyvolaná len po iniciácii widgetu s kódom stiahnutým zo záložky Zber.

  • Widget kompletne skrytý: feedbackWidgetBox.hide ();
  • Widget minimalizovaný: feedbackWidgetBox.invitation ();
  • Widget maximalizovaný: feedbackWidgetBox.show ();
  • Prepne medzi maximalizovaným a minimalizovaným widgetem: feedbackWidgetBox.toggle ();
  • Zobraziť hodnotu Capping: feedbackWidgetBox.getCapping (); – táto funkcia vracia počet zobrazení widgetu
  • Resetovanie Capping: feedbackWidgetBox.resetCapping (); – táto funkcia určuje počet zobrazení widgetu na 0

Udalosti na spracovanie

Udalosti môžu byť definované po iniciácii widgetu s kódom stiahnutým zo záložky Zber.

Funkcia Dôvod vyvolania
feedbackWidgetBox.oninit Called after the initialization of the widget script is finished
feedbackWidgetBox.onchangeState Called when the state of the widget display is changed, function parameter returns the name of the state – show/hide/invitation
feedbackWidgetBox.onfilledSurvey Called after the survey is completed in the widget
feedbackWidgetBox.onclose Called when a user close the widget with X
feedbackWidgetBox.onshownAgain Called when the widget is not displayed because it was closed with X or the completed survey
feedbackWidgetBox.oncappingGained Called when the widget is not displayed because a set number of displays has been reached (capping)

Spôsob definovania funkcií a ukážky použitia:

feedbackWidgetBox.oninit = function() {
    console.log('Widget inicializován');
    console.log('Hodnota cappingu: '+ feedbackWidgetBox.getCapping());
};

feedbackWidgetBox.onchangeState = function(state) {
    console.log('Změna stavu zobrazení widgetu (zobrazit/schovat/pozvánka): '+ state;
};

feedbackWidgetBox.onfilledSurvey = function() {
    console.log('Uživatel vyplnil dotazník ve widgetu');
};

feedbackWidgetBox.onclose = function() {
    console.log('Uživatel uzavřel widget s X');
};

feedbackWidgetBox.onshownAgain = function() {
    console.log('Uživatel vyplnil dotazník předtím nebo ho uzavřel - widget není zobrazen');
};

feedbackWidgetBox.oncappingGained = function() {
    console.log('Uživatel již widget viděl dostatečněkrát - capping byl naplněn')
};

Technická dokumentácia pre widget na webovú stránku. Widget možno získať tým, že vytvoríte dotazník typu: „Widget“.

Pomohol Vám tento článok?

Ďakujeme za odpoveď