Class TextButton

Définit le texte de substitution du bouton à des fins d'accessibilité. Si elle n'est pas définie, la valeur par défaut est le texte affiché sur le bouton.

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un 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 objet d'interface utilisateur ne peut avoir qu'une seule valeur définie parmi 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

Renvois

TextButton : cet objet, pour le chaînage.

Définit la couleur d'arrière-plan du bouton TextButtonStyle.FILLED. Si cette valeur n'est pas définie pour un bouton TextButtonStyle.FILLED, le bouton utilise la couleur secondaire définie dans le manifest du module complémentaire. Cette méthode n'a aucune action pour les boutons TextButtonStyle.OUTLINED.

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit une action qui compose un e-mail d'envoi lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi 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).

// ...

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

// ...

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

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit si le bouton est désactivé. Un bouton désactivé est grisé et ne peut pas être cliqué.

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit un Icon prédéfini à afficher sur le bouton. Vous devez utiliser cette valeur ou setIconUrl(url) pour définir l'image du bouton.

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit l'URL d'une image à utiliser comme icône de ce bouton. Vous devez utiliser cette valeur ou setIcon(icon) pour définir l'image du bouton.

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit l'icône Material Design.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi 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

Renvois

TextButton : cet objet, pour le chaînage.

Définit une action qui ouvre une URL dans un onglet lorsqu'un 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 objet d'interface utilisateur ne peut avoir qu'une seule valeur définie parmi 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

Renvois

TextButton : cet objet, pour le chaînage.

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 ne doit être ouverte que. Un objet d'interface utilisateur ne peut avoir qu'une seule valeur parmi setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit un menu pop-up à ouvrir lorsque l'utilisateur clique sur l'objet. Chaque élément du menu peut spécifier une action à déclencher lorsqu'il est cliqué. Les menus imbriqués ne sont pas acceptés. Les actions pour les éléments de menu ne doivent pas spécifier de menu à développer.

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

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit le texte à afficher sur le bouton.

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.

Définit le style du bouton. Si elle n'est pas définie, la valeur par défaut est le bouton TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Paramètres

Renvois

TextButton : cet objet, pour le chaînage.