Class CardAction

CardAction

Élément de menu cliquable ajouté au menu de l'en-tête de la fiche.

const action = CardService.newAction();
// Finish building the action...

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

Méthodes

Méthode	Type renvoyé	Brève description
setAuthorizationAction(action)	CardAction	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
setComposeAction(action, composedEmailType)	CardAction	Définit une action qui rédige un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
setOnClickAction(action)	CardAction	Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
setOnClickOpenLinkAction(action)	CardAction	Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
setOpenLink(openLink)	CardAction	Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
setText(text)	CardAction	Définit le texte du menu pour cette action.

Documentation détaillée

setAuthorizationAction(action)

Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet. L'URL s'ouvre dans une nouvelle fenêtre. Lorsque l'utilisateur termine le flux d'autorisation et revient à l'application, le module complémentaire se recharge.

Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Paramètres

Nom	Type	Description
action	AuthorizationAction	Objet qui spécifie l'action d'autorisation à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

CardAction : cet objet, pour l'association en chaîne.

---

setComposeAction(action, composedEmailType)

Définit une action qui rédige un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ComposeActionResponse configuré à l'aide de ComposeActionResponseBuilder.setGmailDraft(draft).

Remarque : Cette méthode ne définit pas d'action de rédaction utilisée pour étendre l'interface utilisateur de rédaction. Elle associe plutôt cet élément d'interface utilisateur à un Action qui rédige des brouillons de messages dans Apps Script, lesquels sont ouverts dans Gmail une fois l'action terminée.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Paramètres

Nom	Type	Description
action	Action	Objet qui spécifie l'action de rédaction à effectuer lorsque l'utilisateur clique sur cet élément.
composedEmailType	ComposedEmailType	Valeur d'énumération qui indique si le brouillon rédigé est un brouillon autonome ou une réponse.

Renvois

CardAction : cet objet, pour l'association en chaîne.

---

setOnClickAction(action)

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ActionResponse.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

Paramètres

Nom	Type	Description
action	Action	Action à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

CardAction : cet objet, pour l'association en chaîne.

---

setOnClickOpenLinkAction(action)

Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL doit être créée ou lorsque vous devez effectuer d'autres actions en plus de créer l'objet OpenLink. Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Le paramètre Action doit spécifier une fonction de rappel qui renvoie un objet ActionResponse configuré à l'aide de ActionResponseBuilder.setOpenLink(openLink).

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

Paramètres

Nom	Type	Description
action	Action	Objet qui spécifie l'action d'ouverture de lien à effectuer lorsque l'utilisateur clique sur cet élément.

Renvois

CardAction : cet objet, pour l'association en chaîne.

---

setOpenLink(openLink)

Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle doit uniquement être ouverte. Un seul des éléments suivants peut être défini pour un objet d'interface utilisateur : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

Nom	Type	Description
openLink	OpenLink	Objet OpenLink décrivant l'URL à ouvrir.

Renvois

CardAction : cet objet, pour l'association en chaîne.

---

setText(text)

Définit le texte du menu pour cette action.

Paramètres

Nom	Type	Description
text	String	Texte de l'élément de menu.

Renvois

CardAction : cet objet, pour l'association en chaîne.