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

Class TextButton

Élément TextButton avec un libellé textuel. 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.

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'objet est sur lesquels l'utilisateur a cliqué.
`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 brouillon d'e-mail lorsqu'un 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 qui s'affiche 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, le texte s'affiche sur le bouton.

Paramètres

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

Renvois

TextButton : objet utilisé pour le chaînage.

`setAuthorizationAction(action)`

Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'objet est sur lesquels l'utilisateur a cliqué. L'URL s'ouvre dans une nouvelle fenêtre. Lorsque l'utilisateur a terminé le flux d'autorisation et revient à l'application, le module complémentaire est actualisé.

Un objet d'UI 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`	L'objet qui spécifie l'action d'autorisation à effectuer lorsque cet élément est sur lesquels l'utilisateur a cliqué.

Renvois

TextButton : objet utilisé 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, celui-ci 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 #chromecast.

Renvois

TextButton : objet utilisé pour le chaînage.

`setComposeAction(action, composedEmailType)`

Définit une action qui compose un brouillon d'e-mail lorsqu'un utilisateur clique sur l'objet. Un objet UI ne peut avoir l'une des valeurs suivantes : 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).

</ph> Remarque: Cette méthode ne définit pas d'action de composition qui soit utilisées pour étendre l'interface utilisateur de Compose. Cette méthode connecte plutôt cet élément d'interface utilisateur à un élément Action qui rédige les brouillons dans Apps Script qui sont ouvert 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`	L'objet qui spécifie l'action de composition à effectuer lorsque cet élément est sur lesquels l'utilisateur a cliqué.
`composedEmailType`	`ComposedEmailType`	Valeur d'énumération qui spécifie si le brouillon composé est un seul ou en tant que brouillon de réponse.

Renvois

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

`setOnClickAction(action)`

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. Un objet d'UI ne peut être associé qu'à l'une des valeurs setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) définis.

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 : objet utilisé 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 créer l'objet OpenLink. Un objet d'UI ne peut contenir que l'un des éléments suivants : 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 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 de lien ouvert à effectuer lorsque cet élément est sur lesquels l'utilisateur a cliqué.

Renvois

TextButton : objet utilisé 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à connues et ne doivent qu’être ouvertes. Un objet d'UI ne peut être associé qu'à l'une des valeurs suivantes : setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) définis.

Paramètres

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

Renvois

TextButton : objet utilisé pour le chaînage.

`setText(text)`

Définit le texte qui s'affiche sur le bouton.

Paramètres

Nom	Type	Description
`text`	`String`	Texte qui s'affiche sur le bouton.

Renvois

TextButton : objet utilisé pour le chaînage.

`setTextButtonStyle(textButtonStyle)`

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

Paramètres

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

Renvois

TextButton : objet utilisé pour le chaînage.