Un widget che mostra del testo con decorazioni facoltative. Le chiavi possibili includono un'icona, un'etichetta sopra e un'etichetta sotto. È necessario impostare i contenuti testuali e una delle chiavi usando setText(text)
e uno tra DecoratedText
, DecoratedText
, setTopLabel(text)
o setBottomLabel(text)
. Questa classe deve 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 viene fatto clic sull'oggetto. |
setBottomLabel(text) | DecoratedText | Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sotto i contenuti del testo. |
setButton(button) | DecoratedText | Imposta il valore Button che viene visualizzato a destra del testo. |
setComposeAction(action, composedEmailType) | DecoratedText | Imposta un'azione che scrive una bozza di email quando viene fatto clic sull'oggetto. |
setEndIcon(endIcon) | DecoratedText | Imposta il campo IconImage facoltativo che viene visualizzato a destra dei contenuti. |
setOnClickAction(action) | DecoratedText | Imposta un'azione che viene eseguita quando si fa clic sull'oggetto. |
setOnClickOpenLinkAction(action) | DecoratedText | Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto. |
setOpenLink(openLink) | DecoratedText | Imposta un URL da aprire quando viene fatto clic sull'oggetto. |
setStartIcon(startIcon) | DecoratedText | Consente di impostare il campo facoltativo IconImage da visualizzare prima dei contenuti testuali. |
setSwitchControl(switchToSet) | DecoratedText | Imposta il valore Switch che viene visualizzato 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 del testo. |
setWrapText(wrapText) | DecoratedText | Consente di impostare se il testo del valore deve essere visualizzato su una singola riga o su più righe. |
Documentazione dettagliata
setAuthorizationAction(action)
Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando viene fatto clic sull'oggetto. L'URL si apre in una nuova finestra. Quando l'utente termina il flusso di autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.
Per un oggetto UI è possibile impostare solo uno 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 viene fatto clic su questo elemento. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setBottomLabel(text)
Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sotto i contenuti del testo.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | Il testo dell'etichetta. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setButton(button)
Imposta il valore Button
che viene visualizzato a destra del testo. Un elemento DecoratedText
può
supportare un solo pulsante o un sensore.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
button | Button | Il pulsante da aggiungere. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setComposeAction(action, composedEmailType)
Imposta un'azione che scrive una bozza di email quando viene fatto clic sull'oggetto. Per un oggetto UI
è possibile impostare solo uno tra setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
.
Il parametro Action
deve specificare una funzione di callback che restituisce 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 viene fatto clic su questo elemento. |
composedEmailType | ComposedEmailType | Un valore enum che specifica se la bozza composta è una bozza autonoma o di risposta. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setEndIcon(endIcon)
Imposta il campo IconImage
facoltativo che viene visualizzato a destra dei contenuti. Un elemento DecoratedText
può supportare un solo pulsante, un sensore o una sola icona.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
endIcon | IconImage | L'icona da aggiungere. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setOnClickAction(action)
Imposta un'azione che viene eseguita quando si fa clic sull'oggetto. 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 restituisce 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 viene fatto clic su questo elemento. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setOnClickOpenLinkAction(action)
Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto. Utilizza questa funzione quando
è necessario creare l'URL o quando devi eseguire altre azioni in aggiunta alla creazione dell'oggetto OpenLink
. Per un oggetto UI è possibile impostare un solo elemento setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o
setComposeAction(action, composedEmailType)
.
Il parametro Action
deve specificare una funzione di callback che restituisce 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 viene fatto clic su questo elemento. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setOpenLink(openLink)
Imposta un URL da aprire quando viene fatto clic sull'oggetto. Usa questa funzione quando l'URL è già noto e deve essere solo 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. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setStartIcon(startIcon)
Consente di impostare il campo facoltativo IconImage
da visualizzare prima dei contenuti testuali.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
startIcon | IconImage | L'icona da visualizzare. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setSwitchControl(switchToSet)
Imposta il valore Switch
che viene visualizzato a destra dei contenuti. Un elemento DecoratedText
può supportare un solo pulsante o sensore.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
switchToSet | Switch | Opzione da aggiungere. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setText(text)
Imposta il testo da utilizzare come valore. Supporta la formattazione HTML di base. obbligatorio.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | I contenuti testuali del widget. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setTopLabel(text)
Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sopra i contenuti del testo.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | Il testo dell'etichetta. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.
setWrapText(wrapText)
Consente di impostare se il testo del valore deve essere visualizzato su una singola riga o su più righe.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
wrapText | Boolean | Se true , il testo viene a capo e viene visualizzato su più righe. In caso contrario, il testo viene troncato. |
Ritorni
DecoratedText
: questo oggetto per il concatenamento.