@botfabrik/engine-webclient 4.83.7 → 4.84.0

package/README.md

@@ -18,7 +18,11 @@ Der Webclient wird auf http://meinserver.ch/acme-webclient deployed.
 
 Nachfolgende Properties können dem Client mitgegeben werden:
 
-### useStartScreen (optional)
+### getStartedAction (optional)
+
+Action die ausgeführt wird, wenn der Client das erste mal aufgerufen wird.
+
+### enableStartScreen (optional)
 
 Legt fest, ob vor dem Beginn eines neuen Chats ein Startbildschirm angezeigt wird. Dieser ist besonders nützlich, wenn vom Benutzer eine ausdrückliche Zustimmung, wie beispielsweise die Akzeptanz der Nutzungsbedingungen, erforderlich ist.
 
@@ -102,10 +106,6 @@ Zuunterst im Startbildschirm wird der Start-Chat-Button angezeigt. Das Label kan
 
 Es werden keine Benutzerdaten erfasst, bis der Benutzer durch den Klick auf den Button den Chat startet.
 
-### getStartedAction (optional)
-
-Action die ausgeführt wird, wenn der Client das erste mal aufgerufen wird.
-
 ### commands (optional)
 
 Eine Liste von Befehlen, die der Chatbot unterstützt.
@@ -217,7 +217,7 @@ const webclientProps = {
 bot.addClient(Webclient('webclient', webclientProps));
 ```
 
-### emailExportEnabled (optional)
+### enableTranscriptExportMail (optional, true | false [default])
 
 Erlaubt es, den Chatverlauf an eine Email-Adresse zu verschicken. Idealerweise wird dazu die Middleware @botfabrik/engine-transcript-mail verwendet.
 
@@ -228,13 +228,13 @@ import { requestNLUEvent } from '@botfabrik/engine-core';
 
 const webclientProps = {
   getStartedAction: requestNLUEvent('WELCOME'),
-  emailExportEnabled: true,
+  enableTranscriptExportMail: true,
 };
 
 bot.addClient(Webclient('webclient', webclientProps));
 ```
 
-### pdfExportEnabled (optional)
+### enableTranscriptExportPdf (optional, true | false [default])
 
 Erlaubt es, den Chatverlauf als PDF herunterzuladen. Siehe auch @botfabrik/engine-transcript-export.
 
@@ -242,13 +242,13 @@ Beispiel:
 
 ```typescript
 const webclientProps = {
-  pdfExportEnabled: true,
+  enableTranscriptExportPdf: true,
 };
 
 bot.addClient(Webclient('webclient', webclientProps));
 ```
 
-### showGeneralConditions (optional)
+### enableGeneralConditions (optional, true | false [default])
 
 Mit dieser Option können allgemeine Bedingungen zu Beginn des Chats angezeigt werden.
 
@@ -259,7 +259,7 @@ import { requestNLUEvent } from '@botfabrik/engine-core';
 
 const webclientProps = {
   getStartedAction: requestNLUEvent('WELCOME'),
-  showGeneralConditions: true,
+  enableGeneralConditions: true,
 };
 
 bot.addClient(Webclient('webclient', webclientProps));
@@ -273,11 +273,16 @@ Die Bedingungen beinhalten drei Elemente:
 
 Diese Texte können auch Markdown beinhalten. Um die Standardtexte zu überschreiben, kann man den Übersetzungsmechanismus verwenden.
 
-### conversationRatingEnabled (optional, true | false [default])
+### enableConversationRating (optional, true | false [default])
 
 Ist dieses Property aktiviert, so können Benutzer den Chat mittels Stärnchen bewerten.
 Durch das Bewerten des Chats wird die Action `core.conversation.rating.from.guest` ausgelöst. Die Bewertung wird in Bubble Chat gespeichert (sofern die Middleware aktiv ist).
 
+### enableStandaloneView (optional, true | false [default])
+
+Ermöglicht die Option, den Chat-Client in einem eigenständigen Tab oder Fenster zu öffnen.
+Wenn diese Option auf `true` gesetzt ist, wird eine Button angezeigt, die es den Benutzern ermöglicht, den Chat ausserhalb eines eingebetteten Iframe in einem neuen Browser-Tab öffnen können.
+
 ### fabVisible (optional, true [default] | false)
 
 Falls dieses Property auf `false` ist, erscheint z.B. der FAB (Floating Action Button) auf der Webseite nicht. Der Chatbot kann via FAB nur mittels Bookmarklet verwendet werden.