Class TextInput

TextInput

Widżet pola do wprowadzania danych, który akceptuje wprowadzanie tekstu.

Obsługuje weryfikację przesłanych formularzy. Gdy parametr Action.setAllWidgetsAreRequired(allWidgetsAreRequired) ma wartość true lub ten widżet jest określony za pomocą parametru Action.addRequiredWidget(requiredWidget), działanie przesyłania jest blokowane, chyba że zostanie wprowadzona wartość.

Dostępne w przypadku dodatków do Google Workspace i aplikacji do Google Chat.

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

Metody

Metoda	Zwracany typ	Krótki opis
addEventAction(eventAction)	Widget	Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
setFieldName(fieldName)	TextInput	Ustawia klucz, który identyfikuje to pole wprowadzania tekstu w obiekcie zdarzenia generowanym podczas interakcji z interfejsem.
setHint(hint)	TextInput	Ustawia wskazówkę dotyczącą wprowadzania tekstu.
setHostAppDataSource(hostAppDataSource)	TextInput	Ustawia źródło danych z aplikacji Google Workspace.
setId(id)	Widget	Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmodyfikowany.
setInputMode(inputMode)	TextInput	Określa, czy to pole do wprowadzania danych tekstowych obsługuje wstawianie zmiennych.
setMultiline(multiline)	TextInput	Określa, czy tekst wejściowy ma być wyświetlany w jednym czy w wielu wierszach.
setOnChangeAction(action)	TextInput	Ustawia działanie, które ma być wykonywane za każdym razem, gdy zmienia się wprowadzany tekst.
setSuggestions(suggestions)	TextInput	Ustawia sugestie automatycznego uzupełniania w polu tekstowym.
setSuggestionsAction(suggestionsAction)	TextInput	Ustawia działanie wywołania zwrotnego, aby pobierać sugestie na podstawie danych wejściowych użytkownika na potrzeby autouzupełniania.
setTitle(title)	TextInput	Ustawia tytuł, który ma być wyświetlany nad polem do wprowadzania danych.
setValidation(validation)	TextInput	Ustawia regułę weryfikacji dla tego widżetu.
setValue(value)	TextInput	Ustawia wstępnie wypełnioną wartość, która ma zostać ustawiona w polu do wprowadzania danych.
setVisibility(visibility)	Widget	Ustawia widoczność widżetu.

Szczegółowa dokumentacja

addEventAction(eventAction)

Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.

Parametry

Nazwa	Typ	Opis
eventAction	EventAction	EventAction do dodania.

Powrót

Widget – obiekt do łączenia.

---

setFieldName(fieldName)

Ustawia klucz, który identyfikuje to pole wprowadzania tekstu w obiekcie zdarzenia generowanym podczas interakcji z interfejsem. Niewidoczny dla użytkownika. Wymagany, musi być unikalny.

Parametry

Nazwa	Typ	Opis
fieldName	String	Klucz używany do identyfikowania tego wejścia.

Powrót

TextInput – ten obiekt do łączenia.

---

setHint(hint)

Ustawia wskazówkę dotyczącą wprowadzania tekstu. Służy do przekazywania użytkownikowi dodatkowych wskazówek dotyczących tego, co ma wpisać. Na przykład wskazówka może opisywać formatowanie („xxx-xxx-xxxx”) pola numeru telefonu.

Parametry

Nazwa	Typ	Opis
hint	String	Tekst podpowiedzi do wyświetlenia pod polem do wprowadzania danych. Ten tekst jest zawsze widoczny.

Powrót

TextInput – ten obiekt do łączenia.

---

setHostAppDataSource(hostAppDataSource)

Ustawia źródło danych z aplikacji Google Workspace. Obecnie obsługuje użytkowników i pokoje czatu.

Dostępne tylko w przypadku dodatków do Google Workspace, które rozszerzają Google Workspace Studio.

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

Parametry

Nazwa	Typ	Opis
hostAppDataSource	HostAppDataSource	Źródło danych.

Powrót

TextInput – ten obiekt do łączenia.

---

setId(id)

Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmodyfikowany. Zmiana widżetu jest obsługiwana tylko w dodatkach.

Parametry

Nazwa	Typ	Opis
id	String	Identyfikator widżetu, który może mieć maksymalnie 64 znaki i musi być zgodny z formatem `[a-zA-Z0-9-]+`.

Powrót

Widget – ten obiekt do łączenia.

---

setInputMode(inputMode)

Określa, czy to pole do wprowadzania danych tekstowych obsługuje wstawianie zmiennych.

Dostępne tylko w przypadku dodatków do Google Workspace, które rozszerzają Google Workspace Studio.

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

Parametry

Nazwa	Typ	Opis
inputMode	TextInputMode	Typ danych wejściowych dozwolonych w tym polu do wprowadzania danych. Użyj RICH_TEXT, aby obsługiwać wstawianie zmiennych.

Powrót

TextInput – ten obiekt do łączenia.

---

setMultiline(multiline)

Określa, czy tekst wejściowy ma być wyświetlany w jednym czy w wielu wierszach.

Parametry

Nazwa	Typ	Opis
multiline	Boolean	Ustawienie wielowierszowe.

Powrót

TextInput – ten obiekt do łączenia.

---

setOnChangeAction(action)

Ustawia działanie, które ma być wykonywane za każdym razem, gdy zmienia się wprowadzany tekst.

Parametry

Nazwa	Typ	Opis
action	Action	Działanie do wykonania.

Powrót

TextInput – ten obiekt do łączenia.

---

setSuggestions(suggestions)

Ustawia sugestie automatycznego uzupełniania w polu tekstowym.

Parametry

Nazwa	Typ	Opis
suggestions	Suggestions	Zbiór sugestii do wykorzystania.

Powrót

TextInput – ten obiekt do łączenia.

---

setSuggestionsAction(suggestionsAction)

Ustawia działanie wywołania zwrotnego, aby pobierać sugestie na podstawie danych wejściowych użytkownika na potrzeby autouzupełniania. Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt SuggestionsResponse.

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();
}

Parametry

Nazwa	Typ	Opis
suggestionsAction	Action	Działanie, które pobiera sugestie dotyczące tych danych wejściowych.

Powrót

TextInput – ten obiekt do łączenia.

---

setTitle(title)

Ustawia tytuł, który ma być wyświetlany nad polem do wprowadzania danych. Wymagane.

Parametry

Nazwa	Typ	Opis
title	String	Etykieta tekstowa tego pola.

Powrót

TextInput – ten obiekt do łączenia.

---

setValidation(validation)

Ustawia regułę weryfikacji dla tego widżetu.

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

Parametry

Nazwa	Typ	Opis
validation	Validation	Reguła weryfikacji tego widżetu TextInput.

Powrót

TextInput – ten obiekt do łączenia.

---

setValue(value)

Ustawia wstępnie wypełnioną wartość, która ma zostać ustawiona w polu do wprowadzania danych.

Parametry

Nazwa	Typ	Opis
value	String	Wartość domyślna umieszczona w polu wejściowym. W parametrach wywołania zwrotnego formularza jest zawsze reprezentowany jako ciąg tekstowy.

Powrót

TextInput – ten obiekt do łączenia.

---

setVisibility(visibility)

Ustawia widoczność widżetu. Wartością domyślną jest „VISIBLE”.

Parametry

Nazwa	Typ	Opis
visibility	Visibility	Visibility widżetu.

Powrót

Widget – obiekt do łączenia.