Diese Seite wurde von der Cloud Translation API übersetzt.

Class TextInput

Ein Eingabefeld-Widget, das Texteingaben akzeptiert.

Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.

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 generiert wird, wenn es ist eine Interaktion auf der Benutzeroberfläche.
`setHint(hint)`	`TextInput`	Legt einen Hinweis für die Texteingabe fest.
`setMultiline(multiline)`	`TextInput`	Legt fest, ob der Eingabetext in einer oder in mehreren Zeilen angezeigt wird.
`setOnChangeAction(action)`	`TextInput`	Legt eine Aktion fest, die immer dann 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 zum Abrufen von Vorschlägen auf Basis der Nutzereingabe für die automatische Vervollständigung fest.
`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 generiert wird, wenn es ist eine Interaktion auf der Benutzeroberfläche. 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. Dient dem Nutzer eine zusätzliche Anleitung für die Eingabe. Für Ein Hinweis könnte beispielsweise die Formatierung eines Telefonnummernfelds beschreiben („xxx-xxx-xxxx“).

Parameter

Name	Typ	Beschreibung
`hint`	`String`	Der Texthinweis, der unter dem Eingabefeld angezeigt wird. Dieser Text ist immer sichtbar.

Rückflug

TextInput: Dieses Objekt zur Verkettung.

`setMultiline(multiline)`

Legt fest, ob der Eingabetext in einer oder in 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 immer dann 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 zum Abrufen von Vorschlägen auf Basis der Nutzereingabe für die automatische Vervollständigung fest. Die Der Action-Parameter 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.

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.

`setValue(value)`

Legt den vorausgefüllten Wert fest, der im Eingabefeld festgelegt werden soll.

Parameter

Name	Typ	Beschreibung
`value`	`String`	Der Standardwert für die Eingabe. Er wird im Parameter in Form von Callback-Parametern.

Rückflug

TextInput: Dieses Objekt zur Verkettung.