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 avec les modules complémentaires Google Workspace et les applications Google Chat

var 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 alternatif du bouton pour l'accessibilité.
`setAuthorizationAction(action)`	`TextButton`	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'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 permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet.
`setDisabled(disabled)`	`TextButton`	Détermine si le bouton est désactivé.
`setOnClickAction(action)`	`TextButton`	Définit une action qui s'exécute lorsqu'un utilisateur clique sur l'objet.
`setOnClickOpenLinkAction(action)`	`TextButton`	Définit une action qui ouvre une URL dans un onglet lorsque l'utilisateur clique sur l'objet.
`setOpenLink(openLink)`	`TextButton`	Définit une URL à ouvrir lors d'un clic 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 alternatif du bouton pour l'accessibilité. Si cette règle n'est pas configurée, la valeur par défaut est le texte qui s'affiche sur le bouton.

Paramètres

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

Renvois

TextButton : objet pour le chaînage.

`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 a terminé le flux d'autorisation et retourne dans l'application, le module complémentaire est actualisé.

Un objet d'interface utilisateur ne peut être défini que sur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

var 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 en cas de clic sur cet élément.

Renvois

TextButton : objet pour le chaînage.

`setBackgroundColor(backgroundColor)`

Définit la couleur d'arrière-plan du bouton TextButtonStyle.FILLED. Si la règle n'est pas définie pour un bouton TextButtonStyle.FILLED, le bouton utilise la couleur secondaire définie dans le fichier manifeste du module complémentaire. Cette méthode est une no-op pour les boutons TextButtonStyle.OUTLINED.

Paramètres

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

Renvois

TextButton : objet pour le chaînage.

`setComposeAction(action, composedEmailType)`

Définit une action qui permet de rédiger un brouillon d'e-mail lorsque l'utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut avoir qu'un seul des éléments setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) défini.

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'interface utilisateur de Compose. Cette méthode connecte plutôt cet élément d'interface utilisateur à un Action qui compose des brouillons dans Apps Script, qui sont ouverts dans Gmail une fois l'action terminée.

// ...

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

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var 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 l'utilisateur clique sur cet élément.
`composedEmailType`	`ComposedEmailType`	Valeur d'énumération qui indique si le brouillon composé est autonome ou en réponse à l'ébauche.

Renvois

TextButton : objet pour le chaînage.

`setDisabled(disabled)`

Détermine 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 : objet pour le chaînage.

`setOnClickAction(action)`

Définit une action qui s'exécute lorsqu'un utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut être défini que sur 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.

// ...

var 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 lorsqu'un utilisateur clique sur cet élément.

Renvois

TextButton : objet pour le chaînage.

`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 la création de l'objet OpenLink. Un objet d'interface utilisateur ne peut être défini que sur 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).

// ...

var 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 spécifiant l'action d'ouverture du lien à effectuer en cas de clic sur cet élément.

Renvois

TextButton : objet pour le chaînage.

`setOpenLink(openLink)`

Définit une URL à ouvrir lors d'un clic sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et ne doit être ouverte que. Un objet d'interface utilisateur ne peut être défini que sur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

Paramètres

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

Renvois

TextButton : objet pour le chaînage.

`setText(text)`

Définit le texte à afficher sur le bouton.

Paramètres

Nom	Type	Description
`text`	`String`	Texte qui apparaît sur le bouton.

Renvois

TextButton : objet pour le chaînage.

`setTextButtonStyle(textButtonStyle)`

Définit le style du bouton. Si cette règle n'est pas configurée, elle est définie par défaut sur le bouton TextButtonStyle.OUTLINED.

Paramètres

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

Renvois

TextButton : objet pour le chaînage.