Class TextInput

TekstDane wejściowe

Widżet pola wejściowego, 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

MetodaZwracany typKrótki opis
setFieldName(fieldName)TextInputUstawia klucz, który identyfikuje to pole wprowadzania tekstu w obiekcie zdarzenia generowanym podczas interakcji z interfejsem.
setHint(hint)TextInputUstawia wskazówkę dotyczącą wprowadzania tekstu.
setHostAppDataSource(hostAppDataSource)TextInputUstawia źródło danych z aplikacji Google Workspace.
setMultiline(multiline)TextInputOkreśla, czy tekst wejściowy ma być wyświetlany w jednym czy w wielu wierszach.
setOnChangeAction(action)TextInputUstawia działanie, które ma być wykonywane za każdym razem, gdy zmienia się wprowadzany tekst.
setSuggestions(suggestions)TextInputUstawia sugestie automatycznego uzupełniania w polu tekstowym.
setSuggestionsAction(suggestionsAction)TextInputUstawia działanie wywołania zwrotnego, aby pobierać sugestie na podstawie danych wejściowych użytkownika na potrzeby autouzupełniania.
setTitle(title)TextInputUstawia tytuł, który ma być wyświetlany nad polem wprowadzania.
setValidation(validation)TextInputUstawia regułę weryfikacji dla tego widżetu.
setValue(value)TextInputUstawia wstępnie wypełnioną wartość, która ma zostać ustawiona w polu wejściowym.

Szczegółowa dokumentacja

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

NazwaTypOpis
fieldNameStringKlucz 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

NazwaTypOpis
hintStringTekst podpowiedzi do wyświetlenia pod polem wprowadzania. 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 ramach programu Gemini w wersji alfa dla dodatków do Google Workspace, które rozszerzają funkcje Google Workspace Flows. 

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

NazwaTypOpis
hostAppDataSourceHostAppDataSourceŹródło danych.

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

NazwaTypOpis
multilineBooleanUstawienie 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

NazwaTypOpis
actionActionDziałanie do wykonania.

Powrót

TextInput – ten obiekt, do łączenia.

setSuggestions(suggestions)

Ustawia sugestie automatycznego uzupełniania w polu tekstowym.

Parametry

NazwaTypOpis
suggestionsSuggestionsZbió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

NazwaTypOpis
suggestionsActionActionDział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 wprowadzania. Wymagane.

Parametry

NazwaTypOpis
titleStringEtykieta 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

NazwaTypOpis
validationValidationReguł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 wejściowym.

Parametry

NazwaTypOpis
valueStringWartość 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.