Freigeben über

KAS-Client

  • Artikel

DAS KAS Client SDK bietet eine Brücke zwischen der nativen Schnittstelle der Kaizala-App (Objective-C für iOS, Java für Android) und dem JavaScript Ihrer Kaizala Action.

KasClient-APIs sind im Großen und Ganzen in zwei Kategorien unterteilt:

  1. Formular-APIs: Die Konversation jeder Aktion Karte ist einem Formularobjekt zugeordnet. Ein Formular definiert das Verhalten der Aktion. Um eine Aktion instance müssen Sie ein Formularobjekt initialisieren, die erforderlichen Informationen einfügen und es dann als Anforderung an die jeweilige Konversation übermitteln. Teilnehmer an der Unterhaltung können auf das Formular antworten oder die aggregierte Zusammenfassung aller Antworten anzeigen. Diese APIs wurden erstellt, um alles im Zusammenhang mit Formularen zu behandeln. Basierend auf verschiedenen Flows können diese weiter unterkategorisiert werden in:

    • Erstellungsflow-APIs: Wenn Sie auf das Symbol der Aktion in der Palette tippen, wird der Erstellungsablauf gestartet. Mithilfe dieser APIs können Sie ein Formularobjekt initialisieren, bearbeiten und als Anforderung übermitteln.
    • Antwortfluss-APIs: Durch Tippen auf die Antwortschaltfläche einer Aktion wird Karte deren Antwortflow gestartet. Mithilfe dieser APIs können Sie das zugeordnete Formularobjekt und alle vorherigen Antworten abrufen und eine neue Antwort senden.
    • Zusammenfassungsfluss-APIs: Durch Tippen auf die Schaltfläche "Zusammenfassung" einer Aktion Karte wird der zugehörige Zusammenfassungsflow gestartet. Mithilfe dieser APIs können Sie das zugeordnete Formularobjekt und alle aggregierten Antworten der Teilnehmer abrufen und das Formular schließen, sodass keine weiteren Antworten zulässig sind.

  2. App-APIs: Dies sind APIs, die verwendet werden können, um mit der nativen Schnittstelle des Kaizala-Clients zu interagieren und die erforderlichen Informationen abzurufen. Dazu gehören generische APIs, z. B. Anzeigen der Kontaktauswahl, Bildauswahl, Abrufen des aktuellen Gerätestandorts, App-Gebietsschema usw. Diese APIs können in jedem der oben genannten Flows verwendet werden.

Sie können die aktuelle KASClient Javascript-Datei hier herunterladen.

API-Referenz

Objektverweis

Verweise auf alle Objekte im SDK finden Sie hier.