Class Action

Fügt die Namen der Widgets hinzu, die für eine gültige Einreichung dieser Aktion erforderlich sind. Wenn die Widgets in dieser Liste keinen Wert haben, wenn diese Aktion aufgerufen wird, wird das Senden des Formulars abgebrochen.

Verfügbar für Google Workspace-Add‑ons und Google Chat-Apps.

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),
);

Parameter

Rückflug

Action – Dieses Objekt zur Verkettung.

Gibt an, ob für diese Aktion Eingaben von allen Widgets erforderlich sind.

Verfügbar für Google Workspace-Add‑ons und Google Chat-Apps.

// Creates a button with an action that requires inputs from all widgets.
const button = CardService.newTextButton()
                   .setText('Create notification')
                   .setOnClickAction(
                       CardService.newAction().setAllWidgetsAreRequired(true));

Parameter

Rückflug

Action – Dieses Objekt zur Verkettung.

Legt den Namen der aufzurufenden Callback-Funktion fest. Erforderlich.

Parameter

Rückflug

Action – Dieses Objekt zur Verkettung.

Legt die Interaktion mit einem Nutzer fest. Ist nur beim Öffnen eines Dialogfelds erforderlich. Wenn nichts angegeben ist, reagiert die App wie gewohnt, indem sie eine Action ausführt, z. B. einen Link öffnet oder eine Funktion ausführt.

Nur für Google Chat-Apps verfügbar. Nicht für Google Workspace-Add‑ons verfügbar.

const action = CardService.newAction()
                   .setFunctionName('handleDialog')
                   .setInteraction(CardService.Interaction.OPEN_DIALOG);

Parameter

Rückflug

Action – Dieses Objekt zur Verkettung.

Legt die Ladeanzeige fest, die während der Ausführung der Aktion angezeigt wird.

Parameter

Rückflug

Action – Dieses Objekt zur Verkettung.

Ermöglicht das Übergeben benutzerdefinierter Parameter an die Callback-Funktion. Optional.

Parameter

Rückflug

Action – Dieses Objekt zur Verkettung.

Gibt an, ob Formularwerte durch die Werte des Clients oder des Servers bestimmt werden, nachdem durch eine Aktionsantwort das Card des Formulars aktualisiert wurde. Wenn der Wert auf true gesetzt ist, bleiben die Werte des Clients nach der Serverantwort erhalten. Wenn diese Option auf false festgelegt ist, werden die Formularwerte durch die Serverwerte überschrieben. Die Standardeinstellung ist false.

Durch das Beibehalten der Client-Werte wird verhindert, dass sich ein Formular unerwartet ändert, nachdem ein Nutzer eine Änderung vorgenommen hat. Das kann beispielsweise passieren, wenn ein Nutzer eine Änderung an einem TextInput vornimmt, nachdem er ein Formular gesendet hat, aber bevor der Server antwortet. Wenn die Werte beibehalten werden, bleibt die vom Nutzer vorgenommene Änderung nach der Serverantwort, die Card aktualisiert, erhalten. Andernfalls wird der Formularwert auf den Wert zurückgesetzt, den der Nutzer ursprünglich im Formular angegeben hat.

Wenn Clientwerte beibehalten werden, kann dies die Fähigkeit Ihres Skripts beeinträchtigen, Formularfelder zu leeren oder Formularwerte zu überschreiben. Aktivieren Sie die Beibehaltung daher nicht für diese Art von Funktion. Ohne Persistenz empfiehlt es sich, LoadIndicator.SPINNER für Ereignisse zu verwenden, da dadurch die Benutzeroberfläche gesperrt und Nutzerbearbeitungen verhindert werden, bevor der Server antwortet. Alternativ können Sie LoadIndicator.NONE verwenden und dafür sorgen, dass jedes Element im Formular eine onChange-Aktion hat.

// 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'),
        );

Parameter

Rückflug

Action – Dieses Objekt zur Verkettung.