Sendity Client
Client-Attribute und öffentliche Erweiterungspunkte.
Attribute sind der stabile Vertrag des Sendity Web Clients im Browser. Sie beschreiben Darstellung, die öffentliche Identität der Kampagne und das Timing, aber nie Secrets oder Kanalziele, die auf den Server gehören.
Nutzen Sie diese Seite als Referenz, wenn Sie erzeugtes Markup in eigene Templates oder Adapter-Optionen übertragen. Ändert eine Option das Sicherheitsverhalten statt der Oberfläche, gehört sie vermutlich in die Konfiguration Ihres Servers oder Framework-Adapters.
Unterstützte Attribute
Übersicht der öffentlichen Attribute, die der Sendity Client und der Laravel-Adapter unterstützen.
| Attribut | Typ | Standard | Beschreibung |
|---|---|---|---|
public-key |
string | Pflicht | Kampagnen-ID, die beim Erstellen der Challenge gesendet wird. Das Attribut heißt weiterhin public-key. |
server-url |
URL | https://sendity.io/api | Basis-URL der Sendity API. Bei gehosteten Integrationen können Sie es weglassen; setzen Sie es nur für selbst betriebene APIs. |
transport |
auto | push | polling | auto | auto für normale Integrationen, push, wenn Echtzeit Pflicht ist, oder polling, wenn bewusst keine WebSocket-Infrastruktur bereitsteht. |
lang |
BCP-47-Sprachcode | Browsersprache | Hinweis auf Sprache und Schreibrichtung. Version 0.3.4 bringt englische Fallback-Texte mit; lokalisierte Texte liefern Sie über translations. Bei Änderungen am Attribut werden Schreibrichtung und Texte neu berechnet und die Höhe der Zustände neu gemessen. |
translations |
JSON-Objekt | keiner | Überschreibungen durch die einbindende Seite mit den optionalen Schlüsseln lang, dir, ui und templates. Ungültiges JSON, unbekannte Schlüssel, zu große Daten und Werte, die keine Strings sind, werden ignoriert. |
variant |
card | modal | card | Beide nutzen dieselbe Karte und dieselbe Darstellung der Zustände. Modal ergänzt ein Overlay, Fokussteuerung und öffentliche Methoden zum Öffnen und Schließen. |
position |
center | top | bottom | center | Steuert Position und Einblendeanimation des Modals. |
open |
boolean | aus | Öffnet die Modal-Variante. Steuern Sie es über die Methoden open(), close() und toggle(). Zustandswechsel lösen sendity:opened und sendity:closed aus. |
authenticated-event-delay-ms |
number | 2000 | Verzögerung, bevor nach der Erfolgsanzeige sendity:authenticated ausgelöst wird. |
demo-mode |
boolean | aus | Statischer Vorschaumodus für Doku und Editoren: zeigt Beispieldaten, ohne AuthRequests, Push-Abonnements oder Polling zu starten. |
demo-state |
loading | waiting | warning | error | expired | verified | waiting | Zustand nur für die Vorschau, zusammen mit demo-mode. |
demo-channel |
email | phone | Kanal nur für die Vorschau. phone nutzt die SMS/RCS-Beispieldaten, außer demo-transport ist whatsapp. | |
demo-transport |
keiner | WhatsApp-Beispieldaten nur für die Vorschau, für demo-mode mit demo-channel="phone". Überschreibt nie eine produktive Serveraktion. | |
demo-drawer |
closed | instruction | ready | countdown | processing | Standard des Zustands | Drawer-Zustand nur für die Vorschau, zusammen mit demo-mode. |