Class Action

Działanie

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

MetodaTyp zwracanej wartościKrótki opis
setFunctionName(functionName)ActionUstawia nazwę wywoływanej funkcji wywołania zwrotnego.
setInteraction(interaction)ActionOkreśla interakcję z użytkownikiem, wymagana tylko po otwarciu okna.
setLoadIndicator(loadIndicator)ActionUstawia wskaźnik wczytywania, który wyświetla się w trakcie wykonywania działania.
setParameters(parameters)ActionUmożliwia przekazywanie parametrów niestandardowych do funkcji wywołania zwrotnego.
setPersistValues(persistValues)ActionWskazuje, 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

setFunctionName(functionName)

Ustawia nazwę wywoływanej funkcji wywołania zwrotnego. To pole jest wymagane.

Parametry

NazwaTypOpis
functionNameStringNazwa 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

NazwaTypOpis
interactionInteractionInterakcja 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

NazwaTypOpis
loadIndicatorLoadIndicatorWskaź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

NazwaTypOpis
parametersObjectZaró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

NazwaTypOpis
persistValuesBooleanOkreśla, czy wartości mają zostać zachowane. Domyślna wartość to false.

Powroty

Action – ten obiekt do tworzenia łańcuchów.

Wycofane metody