Class Action

Działanie

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
addRequiredWidget(requiredWidget)	Action	Dodaje nazwy widżetów, których ta akcja wymaga do prawidłowego przesłania.
setAllWidgetsAreRequired(allWidgetsAreRequired)	Action	Wskazuje, czy to działanie 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. Wymagane tylko podczas otwierania okna dialogowego.
setLoadIndicator(loadIndicator)	Action	Ustawia wskaźnik ładowania, który wyświetla się podczas wykonywania działania.
setParameters(parameters)	Action	Umożliwia przekazywanie niestandardowych parametrów do funkcji wywołania zwrotnego.
setPersistValues(persistValues)	Action	Wskazuje, czy wartości formularza są określane przez wartości klienta czy serwera po zaktualizowaniu wartości Card przez odpowiedź działania.

Wycofane metody

Metoda	Zwracany typ	Krótki opis
setMethodName(functionName)	Action

Szczegółowa dokumentacja

addRequiredWidget(requiredWidget)

Dodaje nazwy widżetów, których ta akcja wymaga do prawidłowego przesłania. 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 w przypadku dodatków do Google Workspace i aplikacji Google Chat.

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
requiredWidget	String	Nazwa widżetu wymaganego przez tę czynność.

Powrót

Action – ten obiekt do łańcucha.

---

setAllWidgetsAreRequired(allWidgetsAreRequired)

Wskazuje, czy to działanie wymaga danych wejściowych ze wszystkich widżetów.

Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.

// 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 ze wszystkich widżetów. Domyślna wartość to false.

Powrót

Action – ten obiekt do łańcucha.

---

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 dołączonych bibliotek, takich jak Library.libFunction1.

Powrót

Action – ten obiekt do łańcucha.

---

setInteraction(interaction)

Określa interakcję z użytkownikiem. Wymagane tylko podczas otwierania okna dialogowego. Jeśli nie zostanie określony, aplikacja odpowie, 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.

---

setLoadIndicator(loadIndicator)

Ustawia wskaźnik ładowania, który wyświetla się podczas wykonywania działania.

Parametry

Nazwa	Typ	Opis
loadIndicator	LoadIndicator	Wskaźnik do wyświetlenia.

Powrót

Action – ten obiekt do łańcucha.

---

setParameters(parameters)

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.

---

setPersistValues(persistValues)

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ć, jeśli użytkownik wprowadzi zmiany w TextInput 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 wyczyszczenie pól formularza lub zastąpienie 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 LoadIndicator.SPINNER w przypadku zdarzeń, ponieważ blokuje to interfejs użytkownika i uniemożliwia mu wprowadzanie zmian przed odpowiedzią serwera. Możesz też użyć elementu LoadIndicator.NONE 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
persistValues	Boolean	Określa, czy wartości mają być przechowywane. Domyślna wartość to false.

Powrót

Action – ten obiekt do łańcucha.

Wycofane metody

setMethodName(functionName)

Wycofany. Starsza wersja aliasu dla setFunctionName(functionName).

Parametry

Nazwa	Typ	Opis
functionName	String	Nazwa funkcji. Możesz używać funkcji z dołączonych bibliotek, takich jak Library.libFunction1.

Powrót

Action – ten obiekt do łańcucha.