InteractiveCanvas (Dialogflow)

Das interactiveCanvas-Objekt ist die Schnittstelle für Ihre Unterhaltungsaktion die in Ihrer Webanwendung zur Verfügung gestellt werden.

Hinweis: Das interactiveCanvas-Objekt ist an das window-Objekt angehängt. Wenn Sie Frontend-Framework zur Entwicklung Ihrer Webanwendung nutzen, müssen Sie sicherstellen, haben Sie Zugriff auf window, um die API einzurichten.

Methoden

bereit

ready(callbacks) returns undefined

Wird von der Interactive Canvas-Web-App aufgerufen, nachdem sie geladen wurde, um Callbacks zu registrieren.

Parameter
callbacks	InteractiveCanvasCallbacks Ein Objekt, das Methodenrückrufe enthält.

Hinweis: Sie müssen die ready API in der Webanwendung aufrufen, sobald die Seite geladen. Andernfalls wird die Aktion geschlossen.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Sendet eine Textabfrage an die Unterhaltungsaktion.

Parameter
textQuery	string Die Abfrage, die an die Unterhaltungsaktion gesendet werden soll.
state	string Eines der folgenden Betriebssysteme: READY: Anfragen können von der Plattform akzeptiert werden. BLOCKED: Eine Abfrage ist aktiv und die neue Abfrage wird gelöscht. UNKNOWN: Der aktuelle Abfragestatus konnte nicht ermittelt werden.

Achtung :textQuery darf maximal 640 Zeichen enthalten.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Legt die Höhe der Kopfzeile oben auf einer Anzeige fest.

Parameter
height	number Die Höhe in Pixeln.

InteractiveCanvasCallbacks

Mit diesen Callbacks kannst du auf Informationen oder Anfragen aus Ihrer Konversation, während die Methoden eine Möglichkeit bieten, Informationen oder Anfragen zu Ihrem Gesprächsstil.

onUpdate

onUpdate(data) returns undefined

Wird aufgerufen, wenn eine HtmlResponse aus der Unterhaltungsaktion gesendet wird. Nachher am Ende des Funktionsaufrufs beginnt, wird die Sprachausgabe sofort gestartet.

Parameter
data	Object Aktualisierte Daten, die vom Webhook gesendet wurden.

onTtsMark

onTtsMark(markName) returns undefined

Callback, der während der Text-in-Sprache-Wiedergabe aufgerufen wird.

Sonderzeichen, die immer ausgelöst werden:

• START gibt den Beginn der Sprachausgabe an.
• END kennzeichnet das Ende der Sprachausgabe.
• ERROR zeigt einen Fehler bei der Sprachausgabe an.

Sie können benutzerdefinierte Markierungen auch definieren, indem Sie SSML und das <mark>-Tag, z. B. <mark name="custom"/>.

Hinweis:SSML-Markierungen werden in folgenden Fällen nicht aufgerufen: <ph type="x-smartling-placeholder">

</ph>
• Vor der Sprachausgabe tippt der Nutzer auf das Mikrofon oder den interaktiven Canvas. ruft sendTextQuery auf. Die Sprachausgabe wird abgebrochen und alle SSML-Markierungen in werden die Sprachausgabe ignoriert.
• Während der Sprachausgabe tippt der Nutzer auf das Mikrofon oder ruft der Interactive Canvas Client sendTextQuery Die Text-in-Sprache-Funktion und die verbleibende SSML werden unterbrochen. werden ignoriert.

Parameter
markName	string Kennzeichnet den Namen, der während der Sprachausgabe-Wiedergabe aufgerufen wird.