Widżet pola tekstowego, który akceptuje tekst.
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 |
---|---|---|
setFieldName(fieldName) | TextInput | Ustawia klucz, który identyfikuje ten tekst w obiekcie zdarzenia generowanym podczas interakcji z interfejsem użytkownika. |
setHint(hint) | TextInput | Ustawia podpowiedź dla pola tekstowego. |
setMultiline(multiline) | TextInput | Określa, czy tekst wejściowy ma być wyświetlany w jednym wierszu czy w kilku wierszach. |
setOnChangeAction(action) | TextInput | Określa działanie, które ma zostać wykonane, gdy zmieni się tekst. |
setSuggestions(suggestions) | TextInput | Ustawia sugestie do automatycznego uzupełniania w polu tekstowym. |
setSuggestionsAction(suggestionsAction) | TextInput | Ustawia działanie wywołania zwrotnego, aby pobrać 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ść w polu tekstowym. |
Szczegółowa dokumentacja
setFieldName(fieldName)
Ustawia klucz, który identyfikuje ten tekst w obiekcie zdarzenia generowanym podczas interakcji z interfejsem użytkownika. Niewidoczne dla użytkownika. Wymagane, musi być unikalny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
fieldName | String | Klucz używany do identyfikacji tego wejścia. |
Powrót
TextInput
– ten obiekt do łańcucha.
setHint(hint)
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
TextInput
– ten obiekt do łańcucha.
setMultiline(multiline)
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
TextInput
– ten obiekt do łańcucha.
setOnChangeAction(action)
setSuggestions(suggestions)
Ustawia sugestie do automatycznego uzupełniania w polu tekstowym.
Parametry
Nazwa | Typ | Opis |
---|---|---|
suggestions | Suggestions | Kolekcja sugestii do użycia. |
Powrót
TextInput
– ten obiekt do łańcucha.
setSuggestionsAction(suggestionsAction)
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 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 dla tego elementu danych wejściowych. |
Powrót
TextInput
– ten obiekt do łańcucha.
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 łańcucha.
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 łańcucha.
setValue(value)
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
TextInput
– ten obiekt do łańcucha.