Ein Eingabefeld-Widget, das die Texteingabe akzeptiert.
var textInput = CardService.newTextInput() .setFieldName("text_input_form_input_key") .setTitle("Text input title") .setHint("Text input hint");
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
setFieldName(fieldName) | TextInput | Legt den Schlüssel fest, der diese Texteingabe im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird. |
setHint(hint) | TextInput | Legt einen Hinweis für die Texteingabe fest. |
setMultiline(multiline) | TextInput | Legt fest, ob der Eingabetext in einer Zeile oder in mehreren Zeilen angezeigt wird. |
setOnChangeAction(action) | TextInput | Legt eine Aktion fest, die bei jeder Änderung der Texteingabe ausgeführt werden soll. |
setSuggestions(suggestions) | TextInput | Legt die Vorschläge für die automatische Vervollständigung im Textfeld fest. |
setSuggestionsAction(suggestionsAction) | TextInput | Legt die Callback-Aktion zum Abrufen von Vorschlägen fest, die auf Nutzereingaben für die automatische Vervollständigung basieren. |
setTitle(title) | TextInput | Legt den Titel fest, der über dem Eingabefeld angezeigt werden soll. |
setValue(value) | TextInput | Legt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll. |
Detaillierte Dokumentation
setFieldName(fieldName)
Legt den Schlüssel fest, der diese Texteingabe im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird. Für den Nutzer nicht sichtbar. Erforderlich, muss eindeutig sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
fieldName | String | Der Schlüssel, der zur Identifizierung dieser Eingabe verwendet wird. |
Return
TextInput
: Dieses Objekt für Verkettungen.
setHint(hint)
Legt einen Hinweis für die Texteingabe fest. Wird verwendet, um dem Nutzer zusätzliche Hilfestellung bei der Eingabe zu geben. Ein Hinweis könnte beispielsweise die Formatierung („xxx-xxx-xxxx“) für ein Telefonnummernfeld beschreiben.
Parameter
Name | Typ | Beschreibung |
---|---|---|
hint | String | Der Texthinweis, der unter dem Eingabefeld angezeigt werden soll. Dieser Text ist immer sichtbar. |
Return
TextInput
: Dieses Objekt für Verkettungen.
setMultiline(multiline)
Legt fest, ob der Eingabetext in einer Zeile oder in mehreren Zeilen angezeigt wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
multiline | Boolean | Mehrzeilige Einstellung. |
Return
TextInput
: Dieses Objekt für Verkettungen.
setOnChangeAction(action)
setSuggestions(suggestions)
Legt die Vorschläge für die automatische Vervollständigung im Textfeld fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
suggestions | Suggestions | Sammlung von Vorschlägen, die verwendet werden können. |
Return
TextInput
: Dieses Objekt für Verkettungen.
setSuggestionsAction(suggestionsAction)
Legt die Callback-Aktion zum Abrufen von Vorschlägen fest, die auf Nutzereingaben für die automatische Vervollständigung basieren. Der Parameter Action
muss eine Callback-Funktion angeben, die ein SuggestionsResponse
-Objekt zurückgibt.
var action = CardService.newAction() .setFunctionName('suggestionCallback') .setParameters({'numSuggestions': 3}); CardService.newTextInput() .setFieldName('option-field') .setTitle('Option Selected') .setSuggestionsAction(action); // ... function suggestionCallback(e) { var suggestions = CardService.newSuggestions(); var numSuggestions = parseInt(e.parameter['numSuggestions']); for(var i = 1; i <= numSuggestions; i++) { suggestions.addSuggestion('Suggestion ' + i); } return CardService.newSuggestionsResponseBuilder() .setSuggestions(suggestions) .build(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
suggestionsAction | Action | Die Aktion, die Vorschläge für diese Eingabe abruft. |
Return
TextInput
: Dieses Objekt für Verkettungen.
setTitle(title)
Legt den Titel fest, der über dem Eingabefeld angezeigt werden soll. Erforderlich.
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Die Textbeschriftung für diese Eingabe. |
Return
TextInput
: Dieses Objekt für Verkettungen.
setValue(value)
Legt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.
Parameter
Name | Typ | Beschreibung |
---|---|---|
value | String | Der Standardwert in der Eingabe. Sie wird immer als String in den Formular-Callback-Parametern dargestellt. |
Return
TextInput
: Dieses Objekt für Verkettungen.