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

Class DecoratedText

Widget qui affiche du texte avec des décorations facultatives. Les clés possibles incluent une icône, un libellé au-dessus et un libellé en dessous. Vous devez définir le contenu textuel et l'une des clés à l'aide de setText(text) et de l'une des valeurs DecoratedText, DecoratedText, setTopLabel(text) ou setBottomLabel(text). Cette classe est destinée à remplacer KeyValue.

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Méthodes

Méthode	Type renvoyé	Brève description
`setAuthorizationAction(action)`	`DecoratedText`	Définit une action d'autorisation qui ouvre une URL vers le flux d'autorisation lorsque l'utilisateur clique sur l'objet.
`setBottomLabel(text)`	`DecoratedText`	Définit le texte de l'étiquette à utiliser comme clé et qui s'affiche sous le contenu textuel.
`setButton(button)`	`DecoratedText`	Définit le `Button` qui s'affiche à droite du texte.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Définit une action qui compose un e-mail brouillon lorsque l'utilisateur clique sur l'objet.
`setEndIcon(endIcon)`	`DecoratedText`	Définit l'`IconImage` facultatif qui s'affiche à droite du contenu.
`setOnClickAction(action)`	`DecoratedText`	Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet.
`setOnClickOpenLinkAction(action)`	`DecoratedText`	Définit une action qui ouvre une URL dans un onglet lorsqu'un utilisateur clique sur l'objet.
`setOpenLink(openLink)`	`DecoratedText`	Définit une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
`setStartIcon(startIcon)`	`DecoratedText`	Définit l'`IconImage` facultatif à afficher avant le contenu textuel.
`setSwitchControl(switchToSet)`	`DecoratedText`	Définit les `Switch` qui s'affichent à droite du contenu.
`setText(text)`	`DecoratedText`	Définit le texte à utiliser comme valeur.
`setTopLabel(text)`	`DecoratedText`	Définit le texte du libellé à utiliser comme clé et qui s'affiche au-dessus du contenu textuel.
`setWrapText(wrapText)`	`DecoratedText`	Détermine si le texte de la valeur doit s'afficher sur une ou plusieurs lignes.

Documentation détaillée

`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 retourne dans l'application, le module complémentaire est actualisé.

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

Renvois

DecoratedText : objet utilisé pour le chaînage.

`setBottomLabel(text)`

Définit le texte de l'étiquette à utiliser comme clé et qui s'affiche sous le contenu textuel.

Paramètres

Nom	Type	Description
`text`	`String`	Texte du libellé.

Renvois

DecoratedText : cet objet, pour le chaînage.

`setButton(button)`

Définit le Button qui s'affiche à droite du texte. Un DecoratedText ne peut prendre en charge qu'un seul bouton ou qu'un seul commutateur.

Paramètres

Nom	Type	Description
`button`	`Button`	Bouton d'ajout.

Renvois

DecoratedText : cet objet, pour le chaînage.

`setComposeAction(action, composedEmailType)`

Définit une action qui compose un brouillon d'e-mail 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 Compose utilisée pour étendre l'UI Compose. Cette méthode connecte plutôt cet élément d'interface utilisateur à un Action qui rédige les brouillons dans Apps Script, qui s'ouvrent 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() {
  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 l'utilisateur clique sur cet élément.
`composedEmailType`	`ComposedEmailType`	Valeur d'énumération indiquant si le brouillon composé est un brouillon autonome ou de réponse.

Renvois

DecoratedText : objet utilisé pour le chaînage.

`setEndIcon(endIcon)`

Définit l'IconImage facultatif qui s'affiche à droite du contenu. Un DecoratedText ne peut contenir qu'un seul bouton, un seul bouton bascule ou une seule icône.

Paramètres

Nom	Type	Description
`endIcon`	`IconImage`	Icône à ajouter.

Renvois

DecoratedText : 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'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

DecoratedText : 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

DecoratedText : 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

DecoratedText : cet objet, pour le chaînage.

`setStartIcon(startIcon)`

Définit le IconImage facultatif à afficher avant le contenu textuel.

Paramètres

Nom	Type	Description
`startIcon`	`IconImage`	Icône à afficher.

Renvois

DecoratedText : cet objet, pour le chaînage.

`setSwitchControl(switchToSet)`

Définit les Switch qui s'affichent à droite du contenu. Un DecoratedText ne peut prendre en charge qu'un seul bouton ou un seul bouton-poussoir.

Paramètres

Nom	Type	Description
`switchToSet`	`Switch`	Bouton à ajouter.

Renvois

DecoratedText : cet objet, pour le chaînage.

`setText(text)`

Définit le texte à utiliser comme valeur. Compatible avec la mise en forme HTML de base. Obligatoire.

Paramètres

Nom	Type	Description
`text`	`String`	Contenu textuel de ce widget.

Renvois

DecoratedText : cet objet, pour le chaînage.

`setTopLabel(text)`

Définit le texte du libellé à utiliser comme clé et qui s'affiche au-dessus du contenu textuel.

Paramètres

Nom	Type	Description
`text`	`String`	Texte du libellé.

Renvois

DecoratedText : cet objet, pour le chaînage.

`setWrapText(wrapText)`

Indique si le texte de la valeur doit être affiché sur une seule ligne ou sur plusieurs lignes.

Paramètres

Nom	Type	Description
`wrapText`	`Boolean`	Si la valeur est `true`, le texte est renvoyé à la ligne et affiché sur plusieurs lignes. Sinon, le texte est tronqué.

Renvois

DecoratedText : cet objet, pour le chaînage.