Class DecoratedText

Testo decorato

Un widget che mostra il testo con decorazioni facoltative. Le possibili chiavi sono un'icona, un'etichetta sopra e un'etichetta qui sotto. È necessario impostare i contenuti di testo e una delle chiavi usando setText(text) e uno tra DecoratedText, DecoratedText, setTopLabel(text) o setBottomLabel(text). Questo corso è destinato a sostituire KeyValue.

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 nel flusso di autorizzazione quando viene fatto clic sull'oggetto.
setBottomLabel(text)	DecoratedText	Consente di impostare il testo dell'etichetta da utilizzare come chiave e viene visualizzato sotto il contenuto del testo.
setButton(button)	DecoratedText	Imposta il Button che viene visualizzato a destra del testo.
setComposeAction(action, composedEmailType)	DecoratedText	Imposta un'azione che scrive una bozza dell'email quando un utente fa clic sull'oggetto.
setEndIcon(endIcon)	DecoratedText	Consente di impostare il valore facoltativo di IconImage che viene visualizzato a destra dei contenuti.
setOnClickAction(action)	DecoratedText	Imposta un'azione da eseguire quando viene fatto clic sull'oggetto.
setOnClickOpenLinkAction(action)	DecoratedText	Imposta un'azione che apre un URL in una scheda quando l'utente fa clic sull'oggetto.
setOpenLink(openLink)	DecoratedText	Imposta un URL da aprire quando viene fatto clic sull'oggetto.
setStartIcon(startIcon)	DecoratedText	Consente di impostare il valore facoltativo IconImage da visualizzare prima dei contenuti testuali.
setSwitchControl(switchToSet)	DecoratedText	Imposta il Switch che viene visualizzato a destra dei contenuti.
setText(text)	DecoratedText	Consente di impostare 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 stabilire se visualizzare o meno il testo dei valori su una sola riga o su più righe.

Documentazione dettagliata

setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL nel flusso di autorizzazione quando viene fatto clic sull'oggetto. L'URL viene aperto in una nuova finestra. Quando l'utente termina il flusso dell'autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.

Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametri

Nome	Tipo	Descrizione
action	AuthorizationAction	Oggetto che specifica l'azione di autorizzazione da eseguire quando viene fatto clic su questo elemento.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setBottomLabel(text)

Consente di impostare il testo dell'etichetta da utilizzare come chiave e viene visualizzato sotto il contenuto del testo.

Parametri

Nome	Tipo	Descrizione
text	String	Il testo dell'etichetta.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setButton(button)

Imposta il Button che viene visualizzato a destra del testo. Un DecoratedText può supportare un solo pulsante o un sensore.

Parametri

Nome	Tipo	Descrizione
button	Button	Il pulsante da aggiungere.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setComposeAction(action, composedEmailType)

Imposta un'azione che scrive una bozza dell'email quando un utente fa clic sull'oggetto. Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Il parametro Action deve specificare una funzione di callback che restituisce un oggetto ComposeActionResponse configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: questo metodo non imposta un'azione di scrittura che venga utilizzata per estendere l'interfaccia utente di scrittura. Questo metodo collega invece questo elemento UI a un Action che compone bozze di messaggi in Apps Script che vengono aperti in Gmail al termine dell'azione.

// ...

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 di enumerazione che specifica se la bozza composta è una bozza autonoma o una bozza di risposta.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setEndIcon(endIcon)

Consente di impostare il valore facoltativo di IconImage che viene visualizzato a destra dei contenuti. DecoratedText può supportare un solo pulsante, un sensore o un'icona.

Parametri

Nome	Tipo	Descrizione
endIcon	IconImage	L'icona da aggiungere.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setOnClickAction(action)

Imposta un'azione da eseguire quando viene fatto clic sull'oggetto. Un oggetto UI può avere solo uno dei seguenti valori: 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.

// ...

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.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando devi creare l'URL o devi eseguire altre azioni aggiuntive per creare l'oggetto OpenLink. Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

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 link aperto da intraprendere quando viene fatto clic su questo elemento.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setOpenLink(openLink)

Imposta un URL da aprire quando viene fatto clic sull'oggetto. Utilizza questa funzione quando l'URL è già noto e deve essere aperto. Un oggetto UI può avere solo setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Parametri

Nome	Tipo	Descrizione
openLink	OpenLink	Un oggetto OpenLink che descrive l'URL da aprire.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setStartIcon(startIcon)

Consente di impostare il valore facoltativo IconImage da visualizzare prima dei contenuti testuali.

Parametri

Nome	Tipo	Descrizione
startIcon	IconImage	L'icona da visualizzare.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setSwitchControl(switchToSet)

Imposta il Switch che viene visualizzato a destra dei contenuti. Un DecoratedText può supportare solo un pulsante o un sensore.

Parametri

Nome	Tipo	Descrizione
switchToSet	Switch	Il sensore da aggiungere.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setText(text)

Consente di impostare il testo da utilizzare come valore. Supporta la formattazione HTML di base. Obbligatorio.

Parametri

Nome	Tipo	Descrizione
text	String	Il contenuto del testo per questo widget.

Andata e ritorno

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.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.

---

setWrapText(wrapText)

Consente di stabilire se visualizzare o meno il testo dei valori su una sola riga o su più righe.

Parametri

Nome	Tipo	Descrizione
wrapText	Boolean	Se true, il testo viene aggregato e visualizzato su più righe. In caso contrario, il testo viene troncato.

Andata e ritorno

DecoratedText: questo oggetto, per il concatenamento.