Widżet pola do wprowadzania danych, który akceptuje wprowadzanie tekstu.
Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.
var textInput = CardService.newTextInput() .setFieldName("text_input_form_input_key") .setTitle("Text input title") .setHint("Text input hint");
Metody
Metoda | Typ zwracanej wartości | Krótki opis |
---|---|---|
setFieldName(fieldName) | TextInput | Ustawia klucz identyfikujący ten tekst w obiekcie zdarzenia, który jest generowany po interakcji z interfejsem użytkownika. |
setHint(hint) | TextInput | Ustawia wskazówkę dotyczącą wpisywania tekstu. |
setMultiline(multiline) | TextInput | Określa, czy tekst wejściowy ma się wyświetlać w jednym wierszu czy w wielu. |
setOnChangeAction(action) | TextInput | Ustawia działanie, które ma być wykonywane po każdej zmianie wprowadzonego tekstu. |
setSuggestions(suggestions) | TextInput | Ustawia sugestie autouzupełniania w polu tekstowym. |
setSuggestionsAction(suggestionsAction) | TextInput | Ustawia działanie wywołania zwrotnego, aby pobierać sugestie na podstawie danych wejściowych użytkownika do autouzupełniania. |
setTitle(title) | TextInput | Ustawia tytuł, który ma być wyświetlany nad polem do wprowadzania danych. |
setValue(value) | TextInput | Określa wstępnie wypełnioną wartość do ustawienia w polu do wprowadzania danych. |
Szczegółowa dokumentacja
setFieldName(fieldName)
Ustawia klucz identyfikujący ten tekst w obiekcie zdarzenia, który jest generowany po interakcji z interfejsem użytkownika. Niewidoczne dla użytkownika. Wymagane, nie może się powtarzać.
Parametry
Nazwa | Typ | Opis |
---|---|---|
fieldName | String | Klucz używany do identyfikowania tych danych wejściowych. |
Powroty
TextInput
– ten obiekt do tworzenia łańcuchów.
setHint(hint)
Ustawia wskazówkę dotyczącą wpisywania tekstu. Służy do udzielania użytkownikowi dodatkowych wskazówek dotyczących tego, co wpisać. Wskazówką może być na przykład formatowanie („xxx-xxx-xxxx”) w polu numeru telefonu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
hint | String | Tekst podpowiedzi do wyświetlania pod polem do wprowadzania danych. Ten tekst jest zawsze widoczny. |
Powroty
TextInput
– ten obiekt do tworzenia łańcuchów.
setMultiline(multiline)
Określa, czy tekst wejściowy ma się wyświetlać w jednym wierszu czy w wielu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
multiline | Boolean | Ustawienie wielowierszowe. |
Powroty
TextInput
– ten obiekt do tworzenia łańcuchów.
setOnChangeAction(action)
setSuggestions(suggestions)
Ustawia sugestie autouzupełniania w polu tekstowym.
Parametry
Nazwa | Typ | Opis |
---|---|---|
suggestions | Suggestions | Kolekcja sugestii do wykorzystania. |
Powroty
TextInput
– ten obiekt do tworzenia łańcuchów.
setSuggestionsAction(suggestionsAction)
Ustawia działanie wywołania zwrotnego, aby pobierać sugestie na podstawie danych wejściowych użytkownika do autouzupełniania. Parametr Action
musi określać funkcję wywołania zwrotnego, która zwraca obiekt SuggestionsResponse
.
var action = CardService.newAction() .setFunctionName('suggestionCallback') .setParameters({'numSuggestions': 3}); CardService.newTextInput() .setFieldName('option-field') .setTitle('Option Selected') .setSuggestionsAction(action); // ... function suggestionCallback(e) { var suggestions = CardService.newSuggestions(); var numSuggestions = parseInt(e.parameter['numSuggestions']); for(var 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 tych danych wejściowych. |
Powroty
TextInput
– ten obiekt do tworzenia łańcuchów.
setTitle(title)
Ustawia tytuł, który ma być wyświetlany nad polem do wprowadzania danych. To pole jest wymagane.
Parametry
Nazwa | Typ | Opis |
---|---|---|
title | String | Etykieta tekstowa tych danych wejściowych. |
Powroty
TextInput
– ten obiekt do tworzenia łańcuchów.
setValue(value)
Określa wstępnie wypełnioną wartość do ustawienia w polu do wprowadzania danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
value | String | Wartość domyślna umieszczona w danych wejściowych. Jest zawsze reprezentowana jako ciąg znaków w parametrach wywołania zwrotnego formularza. |
Powroty
TextInput
– ten obiekt do tworzenia łańcuchów.