Działanie, które umożliwia interakcję z elementami interfejsu. Działanie nie jest wykonywane bezpośrednio po stronie klienta, tylko wywołuje funkcję wywołania zwrotnego Apps Script z opcjonalnymi parametrami.
Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.
var image = CardService.newImage()
.setOnClickAction(CardService.newAction()
.setFunctionName("handleImageClick")
.setParameters({imageSrc: 'carImage'}));
Metody
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
addRequiredWidget(requiredWidget) | Action | Dodaje nazwy widżetów, których ta akcja potrzebuje do prawidłowego przesłania. |
setAllWidgetsAreRequired(allWidgetsAreRequired) | Action | Wskazuje, czy czynność wymaga danych wejściowych ze wszystkich widżetów. |
setFunctionName(functionName) | Action | Ustawia nazwę wywoływanej funkcji wywołania zwrotnego. |
setInteraction(interaction) | Action | Określa interakcję z użytkownikiem, wymagana tylko po otwarciu okna. |
setLoadIndicator(loadIndicator) | Action | Ustawia wskaźnik wczytywania, który wyświetla się w trakcie wykonywania działania. |
setParameters(parameters) | Action | Umożliwia przekazywanie parametrów niestandardowych do funkcji wywołania zwrotnego. |
setPersistValues(persistValues) | Action | Wskazuje, czy wartości formularza są określane przez wartości klienta czy wartości serwera po zaktualizowaniu pola Card formularza po odpowiedzi na działanie. |
Szczegółowa dokumentacja
addRequiredWidget(requiredWidget)
Dodaje nazwy widżetów, których ta akcja potrzebuje do prawidłowego przesłania. Jeśli widżety na tej liście nie mają wartości po wywołaniu tej akcji, przesyłanie formularza jest przerywane.
Dostępne tylko w aplikacjach Google Chat. Opcja niedostępna w przypadku dodatków do Google Workspace.
var textInput = CardService.newTextInput()
.setFieldName("text_input_1")
.setTitle("Text input title")
// Creates a footer button that requires an input from the above TextInput Widget.
var action = CardService.newAction()
.setFunctionName("notificationCallback")
.addRequiredWidget("text_input_1");
var fixedFooter =
CardService
.newFixedFooter()
.setPrimaryButton(
CardService
.newTextButton()
.setText("help")
.setOnClickAction(action));
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
requiredWidget | String | Nazwa widżetu wymagana przez tę akcję. |
Powroty
Action – ten obiekt do tworzenia łańcuchów.
setAllWidgetsAreRequired(allWidgetsAreRequired)
Wskazuje, czy czynność wymaga danych wejściowych ze wszystkich widżetów.
Dostępne tylko w aplikacjach Google Chat. Opcja niedostępna w przypadku dodatków do Google Workspace.
// Creates a button with an action that requires inputs from all widgets.
const button = CardService.newTextButton()
.setText('Create notification')
.setOnClickAction(
CardService.newAction()
.setAllWidgetsAreRequired(true));
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
allWidgetsAreRequired | Boolean | Określa, czy działanie wymaga danych wejściowych ze wszystkich widżetów. Wartość domyślna to false. |
Powroty
Action – ten obiekt do tworzenia łańcuchów.
setFunctionName(functionName)
Ustawia nazwę wywoływanej funkcji wywołania zwrotnego. Wymagane.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
functionName | String | Nazwa funkcji. Możesz używać funkcji z uwzględnionych bibliotek, np. Library.libFunction1. |
Powroty
Action – ten obiekt do tworzenia łańcuchów.
setInteraction(interaction)
Określa interakcję z użytkownikiem, wymagana tylko po otwarciu okna. Jeśli nie określono inaczej, aplikacja odpowiada, wykonując w normalny sposób polecenie Action, takie jak otwarcie linku lub uruchomienie funkcji.
Dostępne tylko w aplikacjach Google Chat. Opcja niedostępna w przypadku dodatków do Google Workspace.
const action = CardService.newAction()
.setFunctionName('handleDialog')
.setInteraction(CardService.Interaction.OPEN_DIALOG);
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
interaction | Interaction | Interakcja do określenia. |
Powroty
Action – ten obiekt do tworzenia łańcuchów.
setLoadIndicator(loadIndicator)
Ustawia wskaźnik wczytywania, który wyświetla się w trakcie wykonywania działania.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
loadIndicator | LoadIndicator | Wskaźnik do wyświetlenia. |
Powroty
Action – ten obiekt do tworzenia łańcuchów.
setParameters(parameters)
Umożliwia przekazywanie parametrów niestandardowych do funkcji wywołania zwrotnego. Opcjonalnie.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
parameters | Object | Zarówno klucze, jak i wartości muszą być ciągami tekstowymi. |
Powroty
Action – ten obiekt do tworzenia łańcuchów.
setPersistValues(persistValues)
Wskazuje, czy wartości formularza są określane przez wartości klienta czy wartości serwera po zaktualizowaniu pola Card formularza po odpowiedzi na działanie. Gdy ustawiona jest wartość true, wartości klienta są zachowywane po odpowiedzi serwera. Gdy ustawiona jest wartość false, wartości serwera zastępują wartości formularza. Domyślna wartość to false.
Zachowywanie wartości klienckich pomaga zapobiegać niespodziewanym zmianom w formularzu po wprowadzeniu modyfikacji przez użytkownika. Dzieje się tak na przykład wtedy, gdy użytkownik wprowadzi zmianę w TextInput po przesłaniu formularza, ale zanim serwer odpowie. Jeśli wartości zostaną zachowane, zmiana wprowadzona przez użytkownika pozostaje bez zmian po zaktualizowaniu Card w odpowiedzi serwera. W przeciwnym razie wartość formularza zostanie zwrócona do wartości, którą użytkownik pierwotnie wpisał w formularzu.
Trwałe wartości klienta mogą zakłócać możliwość czyszczenia pól formularza lub zastępowania wartości przez skrypt, dlatego nie włączaj trwałości dla tego typu funkcji. Jeśli nie stosujesz trwałych zmian, zalecamy używanie w zdarzeniach zdarzeń LoadIndicator.SPINNER, bo blokuje to interfejs użytkownika i uniemożliwia wprowadzanie zmian przez użytkowników, zanim serwer odpowie. Możesz też użyć parametru LoadIndicator.NONE i upewnić się, że każdy element formularza ma działanie onChange.
// Creates a button with an action that persists the client's values as the on-click action.
const button = CardService.newTextButton()
.setText('Create notification')
.setOnClickAction(
CardService.newAction()
.setPersistValues(true)
.setFunctionName('functionName'));
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
persistValues | Boolean | Określa, czy wartości mają zostać zachowane. Domyślna wartość to false. |
Powroty
Action – ten obiekt do tworzenia łańcuchów.