Widżet pola do wprowadzania danych, który umożliwia wpisywanie 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 | Zwracany typ | Krótki opis |
---|---|---|
setFieldName(fieldName) | TextInput | Ustawia klucz identyfikujący te dane wejściowe w obiekcie zdarzenia, który jest generowany, gdy to interakcja z interfejsem użytkownika. |
setHint(hint) | TextInput | Ustawia wskazówkę dotyczącą wprowadzania tekstu. |
setMultiline(multiline) | TextInput | Określa, czy wpisany tekst ma się wyświetlać w jednym czy w wielu wierszach. |
setOnChangeAction(action) | TextInput | Określa działanie 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 do pobierania sugestii na podstawie danych wejściowych użytkownika do autouzupełniania. |
setTitle(title) | TextInput | Ustawia tytuł tak, aby był wyświetlany nad polem do wprowadzania danych. |
setValue(value) | TextInput | Określa wstępnie wypełnioną wartość, którą będzie można wprowadzić w polu do wprowadzania danych. |
Szczegółowa dokumentacja
setFieldName(fieldName)
Ustawia klucz identyfikujący te dane wejściowe w obiekcie zdarzenia, który jest generowany, gdy to interakcja z interfejsem użytkownika. Niewidoczne dla użytkownika. Wymagana, musi być unikalna.
Parametry
Nazwa | Typ | Opis |
---|---|---|
fieldName | String | Klucz używany do identyfikowania tych danych wejściowych. |
Powrót
TextInput
– obiekt do tworzenia łańcuchów.
setHint(hint)
Ustawia wskazówkę dotyczącą wprowadzania tekstu. Służy do udzielania użytkownikowi dodatkowych wskazówek na temat tego, co wpisać. Dla: Wskazówka może na przykład opisywać formatowanie („xxx-xxx-xxxx”) pola z numerem telefonu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
hint | String | Tekst podpowiedzi wyświetlany pod polem do wprowadzania danych. Ten tekst jest zawsze widoczny. |
Powrót
TextInput
– obiekt do tworzenia łańcuchów.
setMultiline(multiline)
Określa, czy wpisany tekst ma się wyświetlać w jednym czy w wielu wierszach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
multiline | Boolean | Ustawienie z wieloma liniami. |
Powrót
TextInput
– obiekt do tworzenia łańcuchów.
setOnChangeAction(action)
setSuggestions(suggestions)
Ustawia sugestie autouzupełniania w polu tekstowym.
Parametry
Nazwa | Typ | Opis |
---|---|---|
suggestions | Suggestions | Zbiór sugestii do wykorzystania. |
Powrót
TextInput
– obiekt do tworzenia łańcuchów.
setSuggestionsAction(suggestionsAction)
Ustawia działanie wywołania zwrotnego do pobierania sugestii 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. |
Powrót
TextInput
– obiekt do tworzenia łańcuchów.
setTitle(title)
Ustawia tytuł tak, aby był wyświetlany nad polem do wprowadzania danych. Wymagane.
Parametry
Nazwa | Typ | Opis |
---|---|---|
title | String | Etykieta tekstowa dla tych danych wejściowych. |
Powrót
TextInput
– obiekt do tworzenia łańcuchów.
setValue(value)
Określa wstępnie wypełnioną wartość, którą będzie można wprowadzić w polu do wprowadzania danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
value | String | Wartość domyślna we wpisywanych danych. W formularza z parametrami wywołania zwrotnego. |
Powrót
TextInput
– obiekt do tworzenia łańcuchów.