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 du texte et l'une des clés en utilisant setText(text) et l'une des options suivantes : DecoratedText, DecoratedText, setTopLabel(text) ou setBottomLabel(text). Cette classe est destinée à remplacer KeyValue.

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var 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 du libellé à utiliser comme clé et s'affiche sous le contenu du texte.
`setButton(button)`	`DecoratedText`	Définit les `Button` qui s'affichent à droite du texte.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Définit une action qui compose un brouillon lors d'un clic sur l'objet.
`setEndIcon(endIcon)`	`DecoratedText`	Définit le `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 lorsque l'utilisateur clique sur l'objet.
`setOpenLink(openLink)`	`DecoratedText`	Définit l'URL à ouvrir en cas de clic sur l'objet.
`setStartIcon(startIcon)`	`DecoratedText`	Définit l'élément `IconImage` à 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 s'affiche au-dessus du contenu textuel.
`setWrapText(wrapText)`	`DecoratedText`	Détermine si le texte de la valeur doit être affiché 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 lorsque l'utilisateur clique sur l'objet. L'URL s'ouvre dans une nouvelle fenêtre. Une fois que l'utilisateur a terminé le flux d'autorisation et revient à l'application, le module complémentaire s'actualise.

Vous ne pouvez définir qu'un seul des éléments suivants : 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 spécifiant l'action d'autorisation à effectuer lorsque l'utilisateur clique sur cet élément.

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setBottomLabel(text)`

Définit le texte du libellé à utiliser comme clé et s'affiche sous le contenu du texte.

Paramètres

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

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setButton(button)`

Définit les Button qui s'affichent à droite du texte. Un DecoratedText ne peut accepter qu'un seul bouton ou un seul contacteur.

Paramètres

Nom	Type	Description
`button`	`Button`	Bouton à ajouter.

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setComposeAction(action, composedEmailType)`

Définit une action qui compose un brouillon lors d'un clic sur l'objet. Vous ne pouvez définir qu'un seul des éléments setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) pour un objet d'interface utilisateur.

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 permettant d'étendre l'interface utilisateur de Compose. Cette méthode connecte plutôt cet élément d'interface utilisateur à un Action qui compose les brouillons dans Apps Script qui sont ouverts dans Gmail à la fin de l'action.

// ...

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 spécifiant 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 un brouillon autonome ou de réponse.

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setEndIcon(endIcon)`

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

Paramètres

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

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setOnClickAction(action)`

Définit une action qui s'exécute lorsque l'utilisateur clique sur l'objet. 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.

Aller-retour

DecoratedText : 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 l'URL doit être créée ou lorsque vous devez effectuer d'autres actions en plus de la création de l'objet OpenLink. Vous ne pouvez définir qu'un seul objet 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 lorsque l'utilisateur clique sur cet élément.

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setOpenLink(openLink)`

Définit l'URL à ouvrir en cas de clic sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et qu'elle doit seulement être ouverte. Vous ne pouvez définir qu'un seul objet 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.

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setStartIcon(startIcon)`

Définit l'élément IconImage à afficher avant le contenu textuel.

Paramètres

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

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setSwitchControl(switchToSet)`

Définit les Switch qui s'affichent à droite du contenu. Un DecoratedText ne peut accepter qu'un seul bouton ou un seul contacteur.

Paramètres

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

Aller-retour

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.

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setTopLabel(text)`

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

Paramètres

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

Aller-retour

DecoratedText : cet objet, pour le chaînage

`setWrapText(wrapText)`

Détermine si le texte de la valeur doit être affiché sur une ou plusieurs lignes.

Paramètres

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

Aller-retour

DecoratedText : cet objet, pour le chaînage