Cette page a été traduite par l'API Cloud Translation.

Class Action

Action qui permet d'interagir avec les éléments de l'interface utilisateur. L'action n'a pas lieu directement sur le client, mais appelle plutôt une fonction de rappel Apps Script ; avec des paramètres facultatifs.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.

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

Méthodes

Méthode	Type renvoyé	Brève description
`addRequiredWidget(requiredWidget)`	`Action`	Ajoute les noms des widgets dont cette action a besoin pour un envoi valide.
`setAllWidgetsAreRequired(allWidgetsAreRequired)`	`Action`	Indique si cette action nécessite des entrées de tous les widgets.
`setFunctionName(functionName)`	`Action`	Définit le nom de la fonction de rappel à appeler.
`setInteraction(interaction)`	`Action`	Définit l'interaction avec un utilisateur (obligatoire uniquement à l'ouverture d'une boîte de dialogue).
`setLoadIndicator(loadIndicator)`	`Action`	Définit l'indicateur de chargement qui s'affiche lorsque l'action est en cours.
`setParameters(parameters)`	`Action`	Permet de transmettre des paramètres personnalisés à la fonction de rappel.
`setPersistValues(persistValues)`	`Action`	Indique si les valeurs du formulaire sont déterminées par les valeurs du client ou du serveur après qu'une réponse d'action met à jour la `Card` du formulaire.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`setMethodName(functionName)`	`Action`

Documentation détaillée

`addRequiredWidget(requiredWidget)`

Ajoute les noms des widgets dont cette action a besoin pour un envoi valide. Si les widgets de cette liste n'est associée à aucune valeur lorsque cette action est appelée, l'envoi du formulaire est annulé.

Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires 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));

Paramètres

Nom	Type	Description
`requiredWidget`	`String`	Nom du widget requis par cette action.

Renvois

Action : objet utilisé pour le chaînage.

`setAllWidgetsAreRequired(allWidgetsAreRequired)`

Indique si cette action nécessite des entrées de tous les widgets.

Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires 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));

Paramètres

Nom	Type	Description
`allWidgetsAreRequired`	`Boolean`	Indique si l'action nécessite des entrées de tous les widgets. La valeur par défaut est `false`

Renvois

Action : objet utilisé pour le chaînage.

`setFunctionName(functionName)`

Définit le nom de la fonction de rappel à appeler. Obligatoire.

Paramètres

Nom	Type	Description
`functionName`	`String`	Nom de la fonction. Vous pouvez utiliser des fonctions provenant des bibliothèques incluses, comme `Library.libFunction1`.

Renvois

Action : objet utilisé pour le chaînage.

`setInteraction(interaction)`

Définit l'interaction avec un utilisateur (obligatoire uniquement à l'ouverture d'une boîte de dialogue). Si elle n'est pas spécifiée, l'application répond en exécutant un Action, par exemple en ouvrant un lien ou en exécutant une fonction, comme d'habitude.

Disponible uniquement pour les applications Google Chat. Non disponible pour les modules complémentaires Google Workspace.

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

Paramètres

Nom	Type	Description
`interaction`	`Interaction`	Interaction à spécifier.

Renvois

Action : objet utilisé pour le chaînage.

`setLoadIndicator(loadIndicator)`

Définit l'indicateur de chargement qui s'affiche lorsque l'action est en cours.

Paramètres

Nom	Type	Description
`loadIndicator`	`LoadIndicator`	Indicateur à afficher.

Renvois

Action : objet utilisé pour le chaînage.

`setParameters(parameters)`

Permet de transmettre des paramètres personnalisés à la fonction de rappel. Facultatif.

Paramètres

Nom	Type	Description
`parameters`	`Object`	Les clés et les valeurs doivent être des chaînes.

Renvois

Action : objet utilisé pour le chaînage.

`setPersistValues(persistValues)`

Indique si les valeurs du formulaire sont déterminées par les valeurs du client ou du serveur après qu'une réponse d'action met à jour la Card du formulaire. Si ce paramètre est défini sur true, les valeurs du client persistent après la réponse du serveur. Si ce paramètre est défini sur false, écrasent les valeurs du formulaire. La valeur par défaut est false.

La persistance des valeurs client permet d'éviter les situations dans lesquelles un formulaire change de manière inattendue. après qu'un utilisateur a apporté une modification. Par exemple, si un utilisateur modifie un élément TextInput après envoyer un formulaire, mais avant que le serveur ne réponde. Si les valeurs sont conservées, la modification l'utilisateur a été conservé après que la réponse du serveur a mis à jour le Card ; sinon la valeur du formulaire renvoie la valeur initialement envoyée par l'utilisateur dans le formulaire.

La persistance des valeurs client peut empêcher votre script d'effacer les champs de formulaire ou remplacer les valeurs du formulaire. Par conséquent, évitez d'activer la persistance pour ce type de fonctionnalité. Sans nous vous recommandons d'utiliser LoadIndicator.SPINNER pour les événements, car cela verrouille l'interface utilisateur et empêche les modifications de l'utilisateur avant que le serveur ne réponde. Par ailleurs, vous pouvez utiliser LoadIndicator.NONE et vous assurer que chaque élément du formulaire comporte une instruction onChange action.

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

Paramètres

Nom	Type	Description
`persistValues`	`Boolean`	Permet de spécifier si les valeurs doivent être conservées. La valeur par défaut est `false`.

Renvois

Action : objet utilisé pour le chaînage.

Méthodes obsolètes

`setMethodName(functionName)`

Obsolète. Ancien alias pour setFunctionName(functionName).

Paramètres

Nom	Type	Description
`functionName`	`String`	Nom de la fonction. Vous pouvez utiliser des fonctions provenant des bibliothèques incluses, comme `Library.libFunction1`.

Renvois

Action : objet utilisé pour le chaînage.