Javascript API

Momentan ist unsere API noch in der Beta Phase!

User Objekt setzen

Soll sich geräteübergreifend gemerkt werden, wer bei einem Widget abgestimmt hat, ist es möglich den User anzugeben.

1. Laden und Initialisierung

Bevor der User gesetzt werden kann, ist es nötig zu warten, bis Flowdust geladen und initialisiert ist. Hierzu wird die Flowdust.ready()-Funktion aufgerufen, sobald das Widget bereit ist.

window.onload = () => {
   Flowdust.ready = (Flowdust) => {
   
     // dein code hier
      
     const user = {
       id: "USER_ID",
     }
     
     Flowdust.setUser(user);
   }
 }

Das Flowdust <script> muss vorher geladen werden, bevor Flowdust.ready deklariert werden kann.

2. Manuelle Steuerung

Kann der User nicht gleich gesetzt werden wenn Flowdust bereit ist, ist es möglich das Laden des Widgets komplett manuell zu steuern. Hierzu ruft man folgende Funktion auf:

Flowdust.setManual(true); 

Nun kann der User unabhängig vom Widget gesetzt werden.

Anschließend ruft man

Flowdust.load();

auf, und das Widget wird geladen.

Single Page Apps

Hat man die manuelle Widget Steuerung mit

Flowdust.setManual(true);

aktiviert, ist es bei Single Page Apps (z.B. React) nötig, den folgenden Code aufzurufen, nachdem die User ID gesetzt wurde:

Flowdust.setManual(false);
Flowdust.load();

3. User auslesen

Will man den momentan gesetzten User auslesen, kann man folgende Funktion aufrufen:

const user = Flowdust.getUser();