Class DecoratedText

DecoratedText

Un widget che mostra testo con decorazioni facoltative. Le chiavi possibili includono un'icona, un'etichetta sopra e un'etichetta sotto. L'impostazione del contenuto di testo e di una delle chiavi è obbligatoria 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.

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Metodi

Metodo	Tipo restituito	Breve descrizione
addEventAction(eventAction)	Widget	Aggiunge l'azione evento che può essere eseguita sul widget.
setAuthorizationAction(action)	DecoratedText	Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando si fa clic sull'oggetto.
setBottomLabel(text)	DecoratedText	Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sotto il contenuto di testo.
setButton(button)	DecoratedText	Imposta il Button visualizzato a destra del testo.
setComposeAction(action, composedEmailType)	DecoratedText	Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto.
setEndIcon(endIcon)	DecoratedText	Imposta il IconImage facoltativo visualizzato a destra dei contenuti.
setId(id)	Widget	Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare.
setOnClickAction(action)	DecoratedText	Imposta un'azione da eseguire quando si fa clic sull'oggetto.
setOnClickOpenLinkAction(action)	DecoratedText	Imposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto.
setOpenLink(openLink)	DecoratedText	Imposta un URL da aprire quando si fa clic sull'oggetto.
setStartIcon(startIcon)	DecoratedText	Imposta il IconImage facoltativo da visualizzare prima del contenuto di testo.
setSwitchControl(switchToSet)	DecoratedText	Imposta il Switch 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 il contenuto di testo.
setVisibility(visibility)	Widget	Imposta la visibilità del widget.
setWrapText(wrapText)	DecoratedText	Specifica se il testo del valore deve essere visualizzato su una o più righe.

Documentazione dettagliata

addEventAction(eventAction)

Aggiunge l'azione evento che può essere eseguita sul widget.

Parametri

Nome	Tipo	Descrizione
eventAction	EventAction	EventAction da aggiungere.

Indietro

Widget: l'oggetto, per il concatenamento.

---

setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando si fa clic sull'oggetto. Si apre l'URL in una nuova finestra. Quando l'utente completa il flusso di autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.

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

// ...

const 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 intraprendere quando questo elemento viene cliccato.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setBottomLabel(text)

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

Parametri

Nome	Tipo	Descrizione
text	String	Il testo dell'etichetta.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setButton(button)

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

Parametri

Nome	Tipo	Descrizione
button	Button	Il pulsante per aggiungere.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setComposeAction(action, composedEmailType)

Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto. Un oggetto UI può avere solo uno dei valori 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 ComposeActionResponse configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft).

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

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const 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 composizione da intraprendere quando si fa clic su questo elemento.
composedEmailType	ComposedEmailType	Un valore enum che specifica se la bozza composta è una bozza autonoma o di risposta.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setEndIcon(endIcon)

Imposta il IconImage facoltativo visualizzato a destra dei contenuti. Un DecoratedText può supportare solo un pulsante, un interruttore o un'icona.

Parametri

Nome	Tipo	Descrizione
endIcon	IconImage	L'icona da aggiungere.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setId(id)

Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare. La mutazione dei widget è supportata solo nei componenti aggiuntivi.

Parametri

Nome	Tipo	Descrizione
id	String	L'ID del widget, con un limite di 64 caratteri e nel formato `[a-zA-Z0-9-]+`.

Indietro

Widget: questo oggetto, per il concatenamento.

---

setOnClickAction(action)

Imposta un'azione da eseguire quando si fa clic sull'oggetto. Un oggetto UI può avere impostato 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 ActionResponse.

// ...

const 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 intraprendere quando si fa clic su questo elemento.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL deve essere creato o quando devi intraprendere altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto UI può avere impostato 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 configurato utilizzando ActionResponseBuilder.setOpenLink(openLink).

// ...

const 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 del link da eseguire quando si fa clic su questo elemento.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setOpenLink(openLink)

Imposta un URL da aprire quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già noto e deve solo essere aperto. Un oggetto UI può avere impostato solo uno dei seguenti valori: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parametri

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

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setStartIcon(startIcon)

Imposta il IconImage facoltativo da visualizzare prima del contenuto di testo.

Parametri

Nome	Tipo	Descrizione
startIcon	IconImage	L'icona da visualizzare.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setSwitchControl(switchToSet)

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

Parametri

Nome	Tipo	Descrizione
switchToSet	Switch	L'interruttore da aggiungere.

Indietro

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	Il contenuto di testo per questo widget.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setTopLabel(text)

Imposta il testo dell'etichetta da utilizzare come chiave e viene visualizzato sopra il contenuto di testo.

Parametri

Nome	Tipo	Descrizione
text	String	Il testo dell'etichetta.

Indietro

DecoratedText: questo oggetto, per il concatenamento.

---

setVisibility(visibility)

Imposta la visibilità del widget. Il valore predefinito è "VISIBLE".

Parametri

Nome	Tipo	Descrizione
visibility	Visibility	Il Visibility del widget.

Indietro

Widget: l'oggetto, per il concatenamento.

---

setWrapText(wrapText)

Specifica se il testo del valore deve essere visualizzato su una o più righe.

Parametri

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

Indietro

DecoratedText: questo oggetto, per il concatenamento.