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.

const 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 eine UI-Interaktion stattfindet.
`setHint(hint)`	`TextInput`	Legt einen Hinweis für die Texteingabe fest.
`setMultiline(multiline)`	`TextInput`	Hiermit wird festgelegt, ob der Eingabetext in einer oder mehreren Zeilen angezeigt wird.
`setOnChangeAction(action)`	`TextInput`	Hiermit wird eine Aktion festgelegt, 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`	Hiermit wird die Callback-Aktion festgelegt, um Vorschläge basierend auf der Nutzereingabe für die automatische Vervollständigung abzurufen.
`setTitle(title)`	`TextInput`	Hier legen Sie den Titel fest, der über dem Eingabefeld angezeigt werden soll.
`setValidation(validation)`	`TextInput`	Hier legen Sie die Validierungsregel für dieses Widget fest.
`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 eine UI-Interaktion stattfindet. Nicht für den Nutzer 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. 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 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 Einstellung „Mehrzeilen“.

Rückflug

TextInput – dieses Objekt, zur Verkettung

`setOnChangeAction(action)`

Hiermit wird eine Aktion festgelegt, 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 Vorschläge, die verwendet werden sollen.

Rückflug

TextInput – dieses Objekt, zur Verkettung

`setSuggestionsAction(suggestionsAction)`

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 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)`

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

TextInput – dieses Objekt, zur Verkettung

`setValidation(validation)`

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

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, der in die Eingabe eingefügt wird. Er wird in der Form von Callback-Parametern immer als String dargestellt.

Rückflug

TextInput – dieses Objekt, zur Verkettung