Działanie, które umożliwia interakcję w elementach interfejsu. Działanie nie jest wykonywane bezpośrednio na kliencie, ale wywołuje funkcję wywołania zwrotnego Apps Script z opcjonalnymi parametrami.
Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.
const image = CardService.newImage().setOnClickAction(
CardService.newAction().setFunctionName('handleImageClick').setParameters({
imageSrc: 'carImage'
}),
);
Metody
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
add | Action | Dodaje nazwy widżetów, których potrzebuje to działanie, aby można było je przesłać. |
set | Action | Wskazuje, czy to działanie wymaga danych ze wszystkich widżetów. |
set | Action | Ustawia nazwę wywoływanej funkcji wywołania zwrotnego. |
set | Action | Określa interakcję z użytkownikiem. Wymagane tylko podczas otwierania okna dialogowego. |
set | Action | Ustawia wskaźnik ładowania, który wyświetla się podczas wykonywania działania. |
set | Action | Umożliwia przekazywanie niestandardowych parametrów do funkcji wywołania zwrotnego. |
set | Action | Wskazuje, czy wartości formularza są określane przez wartości klienta czy serwera po zaktualizowaniu wartości Card przez odpowiedź działania. |
Szczegółowa dokumentacja
add
Dodaje nazwy widżetów, których potrzebuje to działanie, aby można było je przesłać. Jeśli podczas wywołania tego działania widżety na tej liście nie mają wartości, przesłanie formularza zostanie przerwane.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków Google Workspace.
const textInput = CardService.newTextInput()
.setFieldName('text_input_1')
.setTitle('Text input title');
// Creates a footer button that requires an input from the above TextInput
// Widget.
const action = CardService.newAction()
.setFunctionName('notificationCallback')
.addRequiredWidget('text_input_1');
const fixedFooter = CardService.newFixedFooter().setPrimaryButton(
CardService.newTextButton().setText('help').setOnClickAction(action),
);
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
required | String | Nazwa widżetu wymaganego przez tę czynność. |
Powrót
Action – ten obiekt do łańcucha.
set
Wskazuje, czy to działanie wymaga danych ze wszystkich widżetów.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków 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 |
|---|---|---|
all | Boolean | Określa, czy działanie wymaga danych ze wszystkich widżetów. Domyślna wartość to false. |
Powrót
Action – ten obiekt do łańcucha.
set
Ustawia nazwę wywoływanej funkcji wywołania zwrotnego. Wymagane.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
function | String | Nazwa funkcji. Możesz używać funkcji z dołączonych bibliotek, takich jak Library.libFunction1. |
Powrót
Action – ten obiekt do łańcucha.
set
Określa interakcję z użytkownikiem. Wymagane tylko podczas otwierania okna dialogowego. Jeśli nie zostanie określony, aplikacja zareaguje, wykonując Action, np. otwierając link lub wykonując funkcję.
Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków Google Workspace.
const action = CardService.newAction()
.setFunctionName('handleDialog')
.setInteraction(CardService.Interaction.OPEN_DIALOG);
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
interaction | Interaction | Interakcja do określenia. |
Powrót
Action – ten obiekt do łańcucha.
set
Ustawia wskaźnik ładowania, który wyświetla się podczas wykonywania działania.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
load | Load | Wskaźnik do wyświetlenia. |
Powrót
Action – ten obiekt do łańcucha.
set
Umożliwia przekazywanie niestandardowych parametrów do funkcji wywołania zwrotnego. Opcjonalnie:
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
parameters | Object | Klucze i wartości muszą być ciągami znaków. |
Powrót
Action – ten obiekt do łańcucha.
set
Wskazuje, czy wartości formularza są określane przez wartości klienta czy serwera po zaktualizowaniu wartości Card przez odpowiedź działania. Gdy ustawisz wartość true, wartości klienta pozostaną po odpowiedzi serwera. Gdy ustawisz wartość false, wartości serwera zastąpią wartości formularza. Domyślna wartość to false.
Zapisywanie wartości klienta pomaga zapobiegać sytuacjom, w których formularz zmienia się nieoczekiwanie po wprowadzeniu przez użytkownika zmian. Może się tak zdarzyć, gdy użytkownik wprowadzi zmiany w Text po przesłaniu formularza, ale przed odpowiedzią serwera. Jeśli wartości są trwałe, zmiany wprowadzone przez użytkownika pozostają po zaktualizowaniu Card przez odpowiedź serwera. W przeciwnym razie wartość formularza wraca do wartości pierwotnie przesłanej przez użytkownika.
Zapisywanie wartości klienta może uniemożliwić skryptowi wyczyszczanie pól formularza lub zastępowanie wartości w formularzu, dlatego nie włączaj trwałości w przypadku tego typu funkcji. W przypadku braku trwałości zalecamy używanie Load w przypadku zdarzeń, ponieważ blokuje to interfejs użytkownika i uniemożliwia mu wprowadzanie zmian przed odpowiedzią serwera. Możesz też użyć elementu Load i zadbać o to, aby każdy element w formularzu miał 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 |
|---|---|---|
persist | Boolean | Określa, czy wartości mają być przechowywane. Domyślna wartość to false. |
Powrót
Action – ten obiekt do łańcucha.