Ein Eingabefeld-Widget, das Texteingaben akzeptiert.
Unterstützt die Validierung von Formulareinreichungen. Wenn Action.setAllWidgetsAreRequired(allWidgetsAreRequired) auf true gesetzt ist oder dieses Widget über Action.addRequiredWidget(requiredWidget) angegeben wird, wird die Übermittlung blockiert, es sei denn, es wird ein Wert eingegeben.
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
const textInput = CardService.newTextInput() .setFieldName('text_input_form_input_key') .setTitle('Text input title') .setHint('Text input hint');
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Text | Legt den Schlüssel fest, der diese Texteingabe im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet. |
set | Text | Legt einen Hinweis für die Texteingabe fest. |
set | Text | Hiermit wird festgelegt, ob der Eingabetext in einer oder mehreren Zeilen angezeigt wird. |
set | Text | Hiermit wird eine Aktion festgelegt, die ausgeführt werden soll, wenn sich die Texteingabe ändert. |
set | Text | Hier legen Sie die Vorschläge für die automatische Vervollständigung im Textfeld fest. |
set | Text | Hiermit wird die Callback-Aktion festgelegt, um Vorschläge basierend auf der Nutzereingabe für die automatische Vervollständigung abzurufen. |
set | Text | Hier legen Sie den Titel fest, der über dem Eingabefeld angezeigt werden soll. |
set | Text | Hier legen Sie die Validierungsregel für dieses Widget fest. |
set | Text | Legt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll. |
Detaillierte Dokumentation
set
Legt den Schlüssel fest, der diese Texteingabe im Ereignisobjekt identifiziert, das generiert wird, wenn eine UI-Interaktion stattfindet. Nicht für den Nutzer sichtbar. Erforderlich, muss eindeutig sein.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
field | String | Der Schlüssel, mit dem diese Eingabe identifiziert wird. |
Rückflug
Text – dieses Objekt, zur Verkettung
set
Legt einen Hinweis für die Texteingabe fest. Gibt dem Nutzer zusätzliche Hinweise zur Eingabe. Ein Hinweis kann 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. |
Rückflug
Text – dieses Objekt, zur Verkettung
set
Hiermit wird festgelegt, ob der Eingabetext in einer oder mehreren Zeilen angezeigt wird.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
multiline | Boolean | Die Einstellung „Mehrzeilen“. |
Rückflug
Text – dieses Objekt, zur Verkettung
set
set
Hier legen Sie die Vorschläge für die automatische Vervollständigung im Textfeld fest.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
suggestions | Suggestions | Die Sammlung der Vorschläge, die verwendet werden sollen. |
Rückflug
Text – dieses Objekt, zur Verkettung
set
Hiermit wird die Callback-Aktion festgelegt, um Vorschläge basierend auf der Nutzereingabe für die automatische Vervollständigung abzurufen. Der Parameter Action muss eine Callback-Funktion angeben, die ein Suggestions-Objekt zurückgibt.
const action = CardService.newAction() .setFunctionName('suggestionCallback') .setParameters({numSuggestions: 3}); CardService.newTextInput() .setFieldName('option-field') .setTitle('Option Selected') .setSuggestionsAction(action); // ... function suggestionCallback(e) { const suggestions = CardService.newSuggestions(); const numSuggestions = Number.parseInt(e.parameter.numSuggestions); for (let i = 1; i <= numSuggestions; i++) { suggestions.addSuggestion(`Suggestion ${i}`); } return CardService.newSuggestionsResponseBuilder() .setSuggestions(suggestions) .build(); }
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
suggestions | Action | Die Aktion, mit der Vorschläge für diese Eingabe abgerufen werden. |
Rückflug
Text – dieses Objekt, zur Verkettung
set
Hier legen Sie den Titel fest, der über dem Eingabefeld angezeigt werden soll. Erforderlich.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
title | String | Das Textlabel für diese Eingabe. |
Rückflug
Text – dieses Objekt, zur Verkettung
set
Hier legen Sie die Validierungsregel für dieses Widget fest.
const validation = CardService.newValidation().setCharacterLimit('10').setType( CardService.InputType.TEXT); const input = CardService.newTextInput() .setFieldName('text_name_xxx1') .setTitle('Max 10 characters') .setValidation(validation);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
validation | Validation | Die Validierungsregel für dieses Text-Widget. |
Rückflug
Text – dieses Objekt, zur Verkettung
set
Legt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
value | String | Der Standardwert, der in die Eingabe eingefügt wird. Sie wird in den Formular-Callback-Parametern immer als String dargestellt. |
Rückflug
Text – dieses Objekt, zur Verkettung