Widżet pola tekstowego, który akceptuje tekst.
Obsługuje weryfikację przesłania formularza. Gdy parametr Action.setAllWidgetsAreRequired(allWidgetsAreRequired) ma wartość true lub ten widżet jest określony za pomocą parametru Action.addRequiredWidget(requiredWidget), przesłanie jest blokowane, chyba że zostanie podana wartość.
Dostępne w przypadku dodatków do Google Workspace i aplikacji 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 |
|---|---|---|
set | Text | Ustawia klucz, który identyfikuje ten tekst w obiekcie zdarzenia generowanym podczas interakcji z interfejsem użytkownika. |
set | Text | Ustawia podpowiedź dla pola tekstowego. |
set | Text | Określa, czy tekst wejściowy ma być wyświetlany w jednym wierszu czy w kilku wierszach. |
set | Text | Określa działanie, które ma być wykonywane po każdej zmianie tekstu. |
set | Text | Ustawia sugestie do automatycznego uzupełniania w polu tekstowym. |
set | Text | Ustawia działanie wywołania zwrotnego, aby pobrać sugestie na podstawie danych wejściowych użytkownika na potrzeby autouzupełniania. |
set | Text | Ustawia tytuł, który ma być wyświetlany nad polem wprowadzania danych. |
set | Text | Ustawia regułę weryfikacji dla tego widżetu. |
set | Text | Ustawia wstępnie wypełnioną wartość w polu tekstowym. |
Szczegółowa dokumentacja
set
Ustawia klucz, który identyfikuje to pole tekstowe w obiekcie zdarzenia wygenerowanym podczas interakcji z interfejsem użytkownika. Niewidoczne dla użytkownika. Wymagane. Musi być unikalny.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
field | String | Klucz używany do identyfikacji tego wejścia. |
Powrót
Text – ten obiekt do łańcucha.
set
Ustawia podpowiedź dla pola tekstowego. Służy do udzielenia użytkownikowi dodatkowych wskazówek dotyczących tego, co należy wpisać. Na przykład podpowiedź może opisywać formatowanie pola numeru telefonu („xxx-xxx-xxxx”).
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
hint | String | Tekst podpowiedzi wyświetlany pod polem wejściowym. Ten tekst jest zawsze widoczny. |
Powrót
Text – ten obiekt do łańcucha.
set
Określa, czy tekst wejściowy ma być wyświetlany w jednym wierszu czy w kilku wierszach.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
multiline | Boolean | Ustawienie wielowierszowe. |
Powrót
Text – ten obiekt do łańcucha.
set
set
Ustawia sugestie do automatycznego uzupełniania w polu tekstowym.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
suggestions | Suggestions | Kolekcja sugestii do użycia. |
Powrót
Text – ten obiekt do łańcucha.
set
Ustawia działanie wywołania zwrotnego, aby pobrać 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 Suggestions.
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 |
|---|---|---|
suggestions | Action | Działanie, które pobiera sugestie dla tego elementu danych wejściowych. |
Powrót
Text – ten obiekt do łańcucha.
set
Ustawia tytuł, który ma być wyświetlany nad polem wprowadzania danych. Wymagane.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
title | String | Etykieta tekstowa tego pola danych. |
Powrót
Text – ten obiekt do łańcucha.
set
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 Text. |
Powrót
Text – ten obiekt do łańcucha.
set
Ustawia wstępnie wypełnioną wartość w polu tekstowym.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
value | String | Wartość domyślna umieszczona w danych wejściowych. Jest on zawsze reprezentowany jako ciąg tekstowy w parametrach funkcji wywołania zwrotnego. |
Powrót
Text – ten obiekt do łańcucha.