Diese Seite wurde von der Cloud Translation API übersetzt.

Class TextInput

Ein Eingabefeld-Widget, das Texteingaben akzeptiert.

Unterstützt die Validierung von Formulareinsendungen. Wenn Action.setAllWidgetsAreRequired(allWidgetsAreRequired) auf true festgelegt ist oder dieses Widget über Action.addRequiredWidget(requiredWidget) angegeben wird, wird die Sendeaktion blockiert, sofern kein Wert eingegeben wird.

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
`addEventAction(eventAction)`	`Widget`	Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.
`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.
`setHostAppDataSource(hostAppDataSource)`	`TextInput`	Legt eine Datenquelle aus Google Workspace-Anwendungen fest.
`setId(id)`	`Widget`	Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird.
`setInputMode(inputMode)`	`TextInput`	Legt fest, ob in diesem Texteingabefeld Variablen eingefügt werden können.
`setMultiline(multiline)`	`TextInput`	Legt fest, ob der eingegebene Text in einer oder mehreren Zeilen angezeigt wird.
`setOnChangeAction(action)`	`TextInput`	Legt eine Aktion fest, die ausgeführt werden soll, wenn sich die Texteingabe ändert.
`setSuggestions(suggestions)`	`TextInput`	Legt die Vorschläge für die automatische Vervollständigung im Textfeld fest.
`setSuggestionsAction(suggestionsAction)`	`TextInput`	Legt die Callback-Aktion fest, um Vorschläge basierend auf der Nutzereingabe für die automatische Vervollständigung abzurufen.
`setTitle(title)`	`TextInput`	Legt den Titel fest, der über dem Eingabefeld angezeigt werden soll.
`setValidation(validation)`	`TextInput`	Legt die Validierungsregel für dieses Widget fest.
`setValue(value)`	`TextInput`	Legt den vorab ausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.
`setVisibility(visibility)`	`Widget`	Legt die Sichtbarkeit des Widgets fest.

Detaillierte Dokumentation

`addEventAction(eventAction)`

Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.

Parameter

Name	Typ	Beschreibung
`eventAction`	`EventAction`	Die hinzuzufügende `EventAction`.

Rückflug

Widget – Das Objekt für die Verkettung.

`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, mit dem diese Eingabe identifiziert wird.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setHint(hint)`

Legt einen Hinweis für die Texteingabe fest. Wird verwendet, um dem Nutzer zusätzliche Hinweise dazu zu geben, was er eingeben soll. 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.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setHostAppDataSource(hostAppDataSource)`

Legt eine Datenquelle aus Google Workspace-Anwendungen fest. Derzeit werden Nutzer und Chatbereiche unterstützt.

Nur für Google Workspace-Add-ons verfügbar, die Google Workspace Studio erweitern.

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

Parameter

Name	Typ	Beschreibung
`hostAppDataSource`	`HostAppDataSource`	Die Datenquelle.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setId(id)`

Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird. Die Mutation von Widgets wird nur in Add-ons unterstützt.

Parameter

Name	Typ	Beschreibung
`id`	`String`	Die ID des Widgets mit einem Limit von 64 Zeichen und im Format `[a-zA-Z0-9-]+`.

Rückflug

Widget: Dieses Objekt zur Verkettung.

`setInputMode(inputMode)`

Legt fest, ob in diesem Texteingabefeld Variablen eingefügt werden können.

Nur für Google Workspace-Add-ons verfügbar, die Google Workspace Studio erweitern.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

Parameter

Name	Typ	Beschreibung
`inputMode`	`TextInputMode`	Der für dieses Texteingabefeld zulässige Eingabetyp. Verwenden Sie RICH_TEXT, um das Einfügen von Variablen zu unterstützen.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setMultiline(multiline)`

Legt fest, ob der eingegebene Text in einer oder mehreren Zeilen angezeigt wird.

Parameter

Name	Typ	Beschreibung
`multiline`	`Boolean`	Die mehrzeilige Einstellung.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setOnChangeAction(action)`

Legt eine Aktion fest, die ausgeführt werden soll, wenn sich die Texteingabe ändert.

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Die erforderliche Aktion.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setSuggestions(suggestions)`

Legt die Vorschläge für die automatische Vervollständigung im Textfeld fest.

Parameter

Name	Typ	Beschreibung
`suggestions`	`Suggestions`	Die Sammlung der zu verwendenden Vorschläge.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setSuggestionsAction(suggestionsAction)`

Legt die Callback-Aktion fest, um Vorschläge basierend auf der Nutzereingabe für die automatische Vervollständigung abzurufen. Der Parameter Action muss eine Callback-Funktion angeben, die ein SuggestionsResponse-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
`suggestionsAction`	`Action`	Die Aktion, mit der Vorschläge für diese Eingabe abgerufen werden.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setTitle(title)`

Legt 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

TextInput: Dieses Objekt zur Verkettung.

`setValidation(validation)`

Legt 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 `TextInput`-Widget.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setValue(value)`

Legt den vorab ausgefü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 immer als String in den Formular-Callback-Parametern dargestellt.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setVisibility(visibility)`

Legt die Sichtbarkeit des Widgets fest. Der Standardwert ist „VISIBLE“.

Parameter

Name	Typ	Beschreibung
`visibility`	`Visibility`	Die `Visibility` des Widgets.

Rückflug

Widget – Das Objekt für die Verkettung.

Class TextInput Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Methoden

Detaillierte Dokumentation

addEventAction(eventAction)

Parameter

Rückflug

setFieldName(fieldName)

Parameter

Rückflug

setHint(hint)

Parameter

Rückflug

setHostAppDataSource(hostAppDataSource)

Parameter

Rückflug

setId(id)

Parameter

Rückflug

setInputMode(inputMode)

Parameter

Rückflug

setMultiline(multiline)

Parameter

Rückflug

setOnChangeAction(action)

Parameter

Rückflug

setSuggestions(suggestions)

Parameter

Rückflug

setSuggestionsAction(suggestionsAction)

Parameter

Rückflug

setTitle(title)

Parameter

Rückflug

setValidation(validation)

Parameter

Rückflug

setValue(value)

Parameter

Rückflug

setVisibility(visibility)

Parameter

Rückflug

Class TextInput

`addEventAction(eventAction)`

`setFieldName(fieldName)`

`setHint(hint)`

`setHostAppDataSource(hostAppDataSource)`

`setId(id)`

`setInputMode(inputMode)`

`setMultiline(multiline)`

`setOnChangeAction(action)`

`setSuggestions(suggestions)`

`setSuggestionsAction(suggestionsAction)`

`setTitle(title)`

`setValidation(validation)`

`setValue(value)`

`setVisibility(visibility)`