Class Action

Działanie

Działanie, które umożliwia interakcję z elementami interfejsu. Czynność nie jest wykonywana bezpośrednio klienta, 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. 

var image = CardService.newImage()
    .setOnClickAction(CardService.newAction()
        .setFunctionName("handleImageClick")
        .setParameters({imageSrc: 'carImage'}));

Metody

MetodaZwracany typKrótki opis
addRequiredWidget(requiredWidget)ActionDodaje nazwy widżetów, których ta akcja jest niezbędna do prawidłowego przesłania zgłoszenia.
setAllWidgetsAreRequired(allWidgetsAreRequired)ActionWskazuje, czy akcja wymaga danych wejściowych ze wszystkich widżetów.
setFunctionName(functionName)ActionUstawia nazwę wywoływanej funkcji wywołania zwrotnego.
setInteraction(interaction)ActionOkreśla interakcję z użytkownikiem – wymagane tylko przy otwieraniu okna.
setLoadIndicator(loadIndicator)ActionUstawia wskaźnik wczytywania, który wyświetla się, gdy działanie jest wykonywane.
setParameters(parameters)ActionUmożliwia przekazywanie parametrów niestandardowych do funkcji wywołania zwrotnego.
setPersistValues(persistValues)ActionWskazuje, czy wartości formularzy są określane na podstawie wartości klienta czy wartości serwera gdy odpowiedź dotycząca działania zaktualizuje pole Card formularza.

Szczegółowa dokumentacja

addRequiredWidget(requiredWidget)

Dodaje nazwy widżetów, które są potrzebne do prawidłowego przesłania danych. Jeśli widżety w ta lista nie ma wartości w momencie wywołania tego działania, więc przesyłanie formularza zostanie przerwane.

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

NazwaTypOpis
requiredWidgetStringNazwa widżetu wymagana przez tę czynność.

Powrót

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

setAllWidgetsAreRequired(allWidgetsAreRequired)

Wskazuje, czy akcja 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

NazwaTypOpis
allWidgetsAreRequiredBooleanOkreśla, czy działanie wymaga danych wejściowych ze wszystkich widżetów. Domyślna wartość to false

Powrót

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

setFunctionName(functionName)

Ustawia nazwę wywoływanej funkcji wywołania zwrotnego. Wymagane.

Parametry

NazwaTypOpis
functionNameStringNazwa funkcji. Możesz używać funkcji z uwzględnionych bibliotek, na przykład Library.libFunction1.

Powrót

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

setInteraction(interaction)

Określa interakcję z użytkownikiem – wymagane tylko przy otwieraniu okna. Jeśli nie określono inaczej, aplikacja odpowiada, wykonując w zwykły sposób działanie 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.

Powrót

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

setLoadIndicator(loadIndicator)

Ustawia wskaźnik wczytywania, który wyświetla się, gdy działanie jest wykonywane.

Parametry

NazwaTypOpis
loadIndicatorLoadIndicatorWskaźnik do wyświetlenia.

Powrót

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

setParameters(parameters)

Umożliwia przekazywanie parametrów niestandardowych do funkcji wywołania zwrotnego. Opcjonalnie:

Parametry

NazwaTypOpis
parametersObjectKlucze i wartości muszą być ciągami znaków.

Powrót

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

setPersistValues(persistValues)

Wskazuje, czy wartości formularzy są określane na podstawie wartości klienta czy wartości serwera gdy odpowiedź dotycząca działania zaktualizuje pole Card formularza. Gdy ustawisz wartość true, wartości klienta utrzymują się po odpowiedzi serwera. Gdy jest ustawiona na false, dyrektywa serwera zastępują wartości w formularzu. Domyślna wartość to false.

Zachowywanie wartości klienta pomaga zapobiegać sytuacjom, w których formularz nieoczekiwanie się zmienia po wprowadzeniu przez użytkownika zmiany. Jeśli na przykład użytkownik wprowadzi zmianę w elemencie TextInput po przez przesłanie formularza, ale zanim serwer zareaguje. Jeśli wartości zostaną zachowane, zmodyfikuj użytkownik pozostaje po zaktualizowaniu Card przez odpowiedź serwera. w przeciwnym razie wartość formularza wraca do wartości, którą użytkownik pierwotnie przesłał w formularzu.

Trwałe wartości klienta mogą zakłócać zdolność skryptu do czyszczenia pól formularza lub zastępować wartości formularza, więc nie włączaj trwałości dla funkcji tego typu. Bez zalecamy używanie właściwości LoadIndicator.SPINNER dla zdarzeń, bo blokuje to interfejs i uniemożliwia użytkownikowi wprowadzanie zmian, zanim serwer odpowie. Ewentualnie możesz użyć LoadIndicator.NONE i upewnić się, że każdy element formularza ma parametr onChange działania. 

// 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ą być zachowywane. Domyślna wartość to false.

Powrót

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

Wycofane metody