Widget affichant 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 avec setText(text)
et l'une des options suivantes : DecoratedText
, DecoratedText
, setTopLabel(text)
ou setBottomLabel(text)
. Cette classe est destinée à remplacer
.
KeyValue
Disponible avec 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'utilisateur clique sur l'objet. |
setBottomLabel(text) | DecoratedText | Définit le texte du libellé à utiliser comme clé et 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 permet de rédiger un brouillon d'e-mail lorsque l'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 lorsqu'un 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 lors d'un clic sur l'objet. |
setStartIcon(startIcon) | DecoratedText | Définit la IconImage facultative à 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. Lorsque l'utilisateur a terminé le flux d'autorisation et retourne dans l'application, le module complémentaire est actualisé.
Un objet d'interface utilisateur 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 | Objet qui spécifie l'action d'autorisation à effectuer en cas de clic sur cet élément. |
Renvois
DecoratedText
: objet pour le chaînage.
setBottomLabel(text)
Définit le texte du libellé à utiliser comme clé et s'affiche sous le contenu textuel.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | Texte du libellé. |
Renvois
DecoratedText
: objet pour le chaînage.
setButton(button)
Définit le Button
qui s'affiche à droite du texte. Un DecoratedText
ne peut accepter qu'un seul bouton ou qu'un seul commutateur.
Paramètres
Nom | Type | Description |
---|---|---|
button | Button | Bouton à ajouter. |
Renvois
DecoratedText
: 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 des éléments 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)
.
// ... 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 réponse à l'ébauche. |
Renvois
DecoratedText
: objet pour le chaînage.
setEndIcon(endIcon)
Définit le IconImage
facultatif qui s'affiche à droite du contenu. Un élément DecoratedText
ne peut accepter qu'un seul bouton, un seul commutateur ou une seule icône.
Paramètres
Nom | Type | Description |
---|---|---|
endIcon | IconImage | Icône à ajouter. |
Renvois
DecoratedText
: objet pour le chaînage.
setOnClickAction(action)
Définit une action qui s'exécute lorsqu'un utilisateur clique sur l'objet. Un objet d'interface utilisateur ne peut être défini que sur 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 lorsqu'un utilisateur clique sur cet élément. |
Renvois
DecoratedText
: 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
. Un objet d'interface utilisateur ne peut être défini que sur 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 en cas de clic sur cet élément. |
Renvois
DecoratedText
: objet pour le chaînage.
setOpenLink(openLink)
Définit une URL à ouvrir lors d'un clic sur l'objet. Utilisez cette fonction lorsque l'URL est déjà connue et ne doit être ouverte que. Un objet d'interface utilisateur ne peut être défini que sur 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
DecoratedText
: objet pour le chaînage.
setStartIcon(startIcon)
Définit la IconImage
facultative à afficher avant le contenu textuel.
Paramètres
Nom | Type | Description |
---|---|---|
startIcon | IconImage | Icône à afficher. |
Renvois
DecoratedText
: 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 qu'un seul commutateur.
Paramètres
Nom | Type | Description |
---|---|---|
switchToSet | Switch | Bouton bascule à ajouter. |
Renvois
DecoratedText
: objet pour le chaînage.
setText(text)
Définit le texte à utiliser comme valeur. Il est compatible avec la mise en forme HTML de base. Obligatoire.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | Contenu textuel de ce widget. |
Renvois
DecoratedText
: 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é. |
Renvois
DecoratedText
: 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 renvoyé à la ligne et s'affiche sur plusieurs lignes. Sinon, le texte est tronqué. |
Renvois
DecoratedText
: objet pour le chaînage.