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
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
add | Widget | Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie. |
set | Text | Ustawia klucz, który identyfikuje to pole wprowadzania tekstu w obiekcie zdarzenia generowanym podczas interakcji z interfejsem. |
set | Text | Ustawia podpowiedź dla wprowadzania tekstu. |
set | Text | Ustawia źródło danych z aplikacji Google Workspace. |
set | Widget | Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. |
set | Text | Określa, czy to pole wprowadzania tekstu obsługuje wstawianie zmiennych. |
set | Text | Określa, czy tekst wejściowy ma być wyświetlany w jednym czy w wielu wierszach. |
set | Text | Ustawia działanie, które ma być wykonywane za każdym razem, gdy zmienia się wprowadzany tekst. |
set | Text | Ustawia sugestie automatycznego uzupełniania w polu tekstowym. |
set | Text | Ustawia działanie wywołania zwrotnego, aby pobierać 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. |
set | Text | Ustawia regułę weryfikacji dla tego widżetu. |
set | Text | Ustawia wstępnie wypełnioną wartość, która ma zostać ustawiona w polu wejściowym. |
set | Widget | Ustawia widoczność widżetu. |
Szczegółowa dokumentacja
add Event Action(eventAction)
Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
event | Event | Event do dodania. |
Powrót
Widget – obiekt do łączenia.
set Field Name(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 |
|---|---|---|
field | String | Klucz używany do identyfikowania tego wejścia. |
Powrót
Text – ten obiekt do łączenia.
set Hint(hint)
Ustawia podpowiedź dla 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 wprowadzania. Ten tekst jest zawsze widoczny. |
Powrót
Text – ten obiekt do łączenia.
set Host App Data Source(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 |
|---|---|---|
host | Host | Źródło danych. |
Powrót
Text – ten obiekt do łączenia.
set Id(id)
Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. Modyfikacja 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.
set Input Mode(inputMode)
Określa, czy to pole wprowadzania tekstu 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 |
|---|---|---|
input | Text | Typ danych wejściowych dozwolonych w tym polu tekstowym. Użyj wartości RICH_TEXT, aby obsługiwać wstawianie zmiennych. |
Powrót
Text – ten obiekt do łączenia.
set Multiline(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
Text – ten obiekt do łączenia.
set On Change Action(action)
set Suggestions(suggestions)
Ustawia sugestie automatycznego uzupełniania w polu tekstowym.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
suggestions | Suggestions | Zbiór sugestii do wykorzystania. |
Powrót
Text – ten obiekt do łączenia.
set Suggestions Action(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 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 dotyczące tych danych wejściowych. |
Powrót
Text – ten obiekt do łączenia.
set Title(title)
Ustawia tytuł, który ma być wyświetlany nad polem wprowadzania. Wymagane.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
title | String | Etykieta tekstowa tego pola. |
Powrót
Text – ten obiekt do łączenia.
set Validation(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 Text. |
Powrót
Text – ten obiekt do łączenia.
set Value(value)
Ustawia wstępnie wypełnioną wartość, która ma zostać ustawiona w polu wejściowym.
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
Text – ten obiekt do łączenia.
set Visibility(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.