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 sont une icône, un libellé ci-dessus et une étiquette 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 options 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.

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'objet est sur lesquels l'utilisateur a cliqué.
`setBottomLabel(text)`	`DecoratedText`	Définit le texte du libellé à utiliser comme clé. Il s'affiche sous le contenu textuel.
`setButton(button)`	`DecoratedText`	Définit le `Button` affiché à droite du texte.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Définit une action qui compose un brouillon d'e-mail lorsqu'un utilisateur clique 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 une URL à ouvrir lorsque l'utilisateur clique sur l'objet.
`setStartIcon(startIcon)`	`DecoratedText`	Définit le `IconImage` facultatif à afficher avant le contenu textuel.
`setSwitchControl(switchToSet)`	`DecoratedText`	Définit le `Switch` affiché à 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 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 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

DecoratedText : objet utilisé pour le chaînage.

`setBottomLabel(text)`

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

Paramètres

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

Renvois

DecoratedText : objet utilisé pour le chaînage.

`setButton(button)`

Définit le Button affiché à droite du texte. Un DecoratedText peut ne prennent en charge qu'un seul bouton ou un seul commutateur.

Paramètres

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

Renvois

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

DecoratedText : objet utilisé 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.

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

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

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

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

`setSwitchControl(switchToSet)`

Définit le Switch affiché à droite du contenu. DecoratedText n'est compatible qu'avec un seul bouton ou contacteur.

Paramètres

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

Renvois

DecoratedText : objet utilisé pour le chaînage.

`setText(text)`

Définit le texte à utiliser comme valeur. est compatible avec le format HTML simplifié ; Obligatoire.

Paramètres

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

Renvois

DecoratedText : objet utilisé 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é.

Renvois

DecoratedText : objet utilisé pour le chaînage.

`setWrapText(wrapText)`

Détermine si le texte de la valeur doit s'afficher sur une ou 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 : objet utilisé pour le chaînage.