Un widget che mostra testo con decorazioni facoltative. Le chiavi possibili includono un'icona, un'etichetta
sopra e un'etichetta sotto. Devi impostare il contenuto di testo e una delle chiavi utilizzando setText(text)
e uno tra DecoratedText
, DecoratedText
, setTopLabel(text)
o setBottomLabel(text)
. Questo corso è destinato a sostituire
.
KeyValue
Disponibile per i componenti aggiuntivi di Google Workspace e le app Google Chat.
var decoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel"); var multilineDecoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel") .setWrapText(true) .setBottomLabel("BottomLabel");
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato. |
setBottomLabel(text) | DecoratedText | Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sotto i contenuti testuali. |
setButton(button) | DecoratedText | Consente di impostare il valore Button che viene visualizzato a destra del testo. |
setComposeAction(action, composedEmailType) | DecoratedText | Imposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto. |
setEndIcon(endIcon) | DecoratedText | Consente di impostare l'elemento IconImage facoltativo che viene visualizzato a destra dei contenuti. |
setOnClickAction(action) | DecoratedText | Imposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto. |
setOnClickOpenLinkAction(action) | DecoratedText | Consente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto. |
setOpenLink(openLink) | DecoratedText | Imposta un URL da aprire quando l'utente fa clic sull'oggetto. |
setStartIcon(startIcon) | DecoratedText | Consente di impostare l'elemento IconImage facoltativo da visualizzare prima dei contenuti testuali. |
setSwitchControl(switchToSet) | DecoratedText | Consente di impostare il valore Switch che viene mostrato a destra dei contenuti. |
setText(text) | DecoratedText | Imposta il testo da utilizzare come valore. |
setTopLabel(text) | DecoratedText | Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sopra i contenuti testuali. |
setWrapText(wrapText) | DecoratedText | Consente di impostare se il testo del valore deve essere visualizzato su una o più righe. |
Documentazione dettagliata
setAuthorizationAction(action)
Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato. L'URL viene aperto in una nuova finestra. Quando l'utente termina il flusso di autorizzazione all'applicazione, il componente aggiuntivo si ricarica.
Per un oggetto UI può essere impostato un solo elemento tra setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | AuthorizationAction | L'oggetto che specifica l'azione di autorizzazione da eseguire quando questo elemento viene selezionato. |
Invio
DecoratedText
: oggetto per il collegamento.
setBottomLabel(text)
Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sotto i contenuti testuali.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | Il testo dell'etichetta. |
Invio
DecoratedText
: oggetto per il collegamento.
setButton(button)
Consente di impostare il valore Button
che viene visualizzato a destra del testo. Un DecoratedText
può
supporta un solo pulsante o un solo sensore.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
button | Button | Il pulsante da aggiungere. |
Invio
DecoratedText
: oggetto per il collegamento.
setComposeAction(action, composedEmailType)
Imposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto. Un oggetto UI può solo
avere uno dei seguenti: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
impostati.
Il parametro Action
deve specificare una funzione di callback che restituisca un oggetto ComposeActionResponse
configurato utilizzando 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(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'oggetto che specifica l'azione di scrittura da eseguire quando questo elemento viene selezionato. |
composedEmailType | ComposedEmailType | Un valore enum che specifica se la bozza composta è un indipendente o una bozza di risposta. |
Invio
DecoratedText
: oggetto per il collegamento.
setEndIcon(endIcon)
Consente di impostare l'elemento IconImage
facoltativo che viene visualizzato a destra dei contenuti. Un DecoratedText
può supportare un solo pulsante, un sensore o un'icona.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
endIcon | IconImage | L'icona da aggiungere. |
Invio
DecoratedText
: oggetto per il collegamento.
setOnClickAction(action)
Imposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto. Un oggetto UI può avere solo uno dei seguenti
Impostazione setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
impostata.
Il parametro Action
deve specificare una funzione di callback che restituisca un oggetto 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(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'azione da eseguire quando l'utente fa clic su questo elemento. |
Invio
DecoratedText
: oggetto per il collegamento.
setOnClickOpenLinkAction(action)
Consente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando
È necessario creare l'URL o quando devi eseguire altre azioni oltre alla creazione dell'oggetto OpenLink
. Un oggetto UI può avere solo uno tra setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o
setComposeAction(action, composedEmailType)
impostato.
Il parametro Action
deve specificare una funzione di callback che restituisca un oggetto ActionResponse
configurato utilizzando 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(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'oggetto che specifica l'azione di apertura link da eseguire quando questo elemento è selezionato. |
Invio
DecoratedText
: oggetto per il collegamento.
setOpenLink(openLink)
Imposta un URL da aprire quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già
noto e deve solo essere aperto. Un oggetto UI può avere solo uno tra setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
impostato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
openLink | OpenLink | Un oggetto OpenLink che descrive l'URL da aprire. |
Invio
DecoratedText
: oggetto per il collegamento.
setStartIcon(startIcon)
Consente di impostare l'elemento IconImage
facoltativo da visualizzare prima dei contenuti testuali.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
startIcon | IconImage | L'icona da visualizzare. |
Invio
DecoratedText
: oggetto per il collegamento.
setSwitchControl(switchToSet)
Consente di impostare il valore Switch
che viene mostrato a destra dei contenuti. DecoratedText
può supportare un solo pulsante o un solo sensore.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
switchToSet | Switch | L'opzione da aggiungere. |
Invio
DecoratedText
: oggetto per il collegamento.
setText(text)
Imposta il testo da utilizzare come valore. Supporta la formattazione HTML di base. Obbligatorio.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | Il contenuto testuale per questo widget. |
Invio
DecoratedText
: oggetto per il collegamento.
setTopLabel(text)
Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sopra i contenuti testuali.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | Il testo dell'etichetta. |
Invio
DecoratedText
: oggetto per il collegamento.
setWrapText(wrapText)
Consente di impostare se il testo del valore deve essere visualizzato su una o più righe.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
wrapText | Boolean | Se true , il testo è a capo e visualizzato su più righe. Altrimenti
il testo è troncato. |
Invio
DecoratedText
: oggetto per il collegamento.