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

Class TextButton

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

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 lorsque l'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 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 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 : cet 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 termine le flux d'autorisation et revient dans l'application, le module complémentaire est actualisé.

Vous ne pouvez définir qu'un seul élément setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) pour un objet d'interface utilisateur.

// ...

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 lorsque l'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 règle n'est pas configurée pour un bouton TextButtonStyle.FILLED, la couleur secondaire définie dans le fichier manifeste du module complémentaire est utilisée. Cette méthode est une "no-op" pour les boutons TextButtonStyle.TEXT.

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 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 ensemble 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'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 s'ouvrent 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 tant que brouillon de réponse.

Renvois

TextButton : cet 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 : cet objet, pour le chaînage.

`setOnClickAction(action)`

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Pour un objet UI, vous ne pouvez définir qu'un seul élément 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 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 lorsque l'utilisateur clique sur l'objet. Utilisez cette fonction lorsque vous devez créer l'URL 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'un seul ensemble 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 qui spécifie l'action d'ouverture du lien à effectuer lorsque l'utilisateur clique sur cet élément.

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 doit seulement être ouverte. Pour un objet d'interface utilisateur, vous ne pouvez définir qu'un seul élément 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 : cet 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 : cet 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.TEXT.

Paramètres

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

Renvois

TextButton : cet objet, pour le chaînage.