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

Class TextButton

TextButton avec un libellé de texte Vous pouvez définir la couleur d'arrière-plan et désactiver le bouton si nécessaire.

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Méthodes

Méthode	Type renvoyé	Brève description
`setAltText(altText)`	`TextButton`	Définit le texte de substitution du bouton à des fins d'accessibilité.
`setAuthorizationAction(action)`	`TextButton`	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsqu'un utilisateur clique sur l'objet.
`setBackgroundColor(backgroundColor)`	`TextButton`	Définit la couleur d'arrière-plan du bouton `TextButtonStyle.FILLED`.
`setComposeAction(action, composedEmailType)`	`TextButton`	Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet.
`setDisabled(disabled)`	`TextButton`	Définit si le bouton est désactivé.
`setIcon(icon)`	`TextButton`	Définit un `Icon` prédéfini à afficher sur le bouton.
`setIconUrl(url)`	`TextButton`	Définit l'URL d'une image à utiliser comme icône de ce bouton.
`setMaterialIcon(icon)`	`TextButton`	Définit l'icône Material Design.
`setOnClickAction(action)`	`TextButton`	Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
`setOnClickOpenLinkAction(action)`	`TextButton`	Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet.
`setOpenLink(openLink)`	`TextButton`	Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
`setOverflowMenu(menu)`	`TextButton`	Définit un menu pop-up à ouvrir lorsque l'utilisateur clique sur l'objet.
`setText(text)`	`TextButton`	Définit le texte à afficher sur le bouton.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Définit le style du bouton.

Documentation détaillée

`setAltText(altText)`

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

Nom	Type	Description
`altText`	`String`	Texte de substitution à attribuer à ce bouton.

Renvois

TextButton : cet objet, pour le chaînage.

`setAuthorizationAction(action)`

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

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

Renvois

TextButton : cet objet, pour le chaînage.

`setBackgroundColor(backgroundColor)`

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 est une opération sans effet pour les boutons TextButtonStyle.OUTLINED.

Paramètres

Nom	Type	Description
`backgroundColor`	`String`	Couleur au format #rgb.

Renvois

TextButton : cet objet, pour le chaînage.

`setComposeAction(action, composedEmailType)`

Définit une action qui compose un e-mail brouillon 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).

Remarque: Cette méthode ne définit pas d'action de composition utilisée pour étendre l'UI de Compose. Cette méthode connecte plutôt cet élément d'interface utilisateur à un Action qui compose des brouillons de messages dans Apps Script qui 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 composition à effectuer lorsque cet élément est cliqué.
`composedEmailType`	`ComposedEmailType`	Valeur d'énumération indiquant si le brouillon composé est un brouillon autonome ou de réponse.

Renvois

TextButton : cet objet, pour le chaînage.

`setDisabled(disabled)`

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

Paramètres

Nom	Type	Description
`disabled`	`Boolean`	État désactivé.

Renvois

TextButton : cet objet, pour le chaînage.

`setIcon(icon)`

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

Nom	Type	Description
`icon`	`Icon`	L'une des valeurs `Icon` prédéfinies.

Renvois

TextButton : cet objet, pour le chaînage.

`setIconUrl(url)`

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

Nom	Type	Description
`url`	`String`	URL d'une image hébergée à utiliser comme icône de ce bouton.

Renvois

TextButton : cet objet, pour le chaînage.

`setMaterialIcon(icon)`

Définit l'icône Material Design.

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

Paramètres

Nom	Type	Description
`icon`	`MaterialIcon`	Icône Material Design.

Renvois

TextButton : cet objet, pour le chaînage.

`setOnClickAction(action)`

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

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

Renvois

TextButton : cet objet, pour le chaînage.

`setOnClickOpenLinkAction(action)`

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

Nom	Type	Description
`action`	`Action`	Objet qui spécifie l'action d'ouverture du lien à effectuer lorsque cet élément est cliqué.

Renvois

TextButton : cet objet, pour le chaînage.

`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 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

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

Renvois

TextButton : cet objet, pour le chaînage.

`setOverflowMenu(menu)`

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

Nom	Type	Description
`menu`	`OverflowMenu`	Objet qui spécifie le menu déroulant à afficher lorsque l'utilisateur clique sur cet élément.

Renvois

TextButton : cet objet, pour le chaînage.

`setText(text)`

Définit le texte à afficher sur le bouton.

Paramètres

Nom	Type	Description
`text`	`String`	Texte affiché sur le bouton.

Renvois

TextButton : cet objet, pour le chaînage.

`setTextButtonStyle(textButtonStyle)`

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

Nom	Type	Description
`textButtonStyle`	`TextButtonStyle`	Style du bouton.

Renvois

TextButton : cet objet, pour le chaînage.