Questa pagina è stata tradotta dall'API Cloud Translation.

Class DecoratedText

Un widget che mostra il testo con decorazioni facoltative. Le possibili chiavi includono un'icona, un'etichetta sopra e un'etichetta sotto. È necessario impostare il contenuto del testo e una delle chiavi utilizzando setText(text) e uno dei valori 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
`setAuthorizationAction(action)`	`DecoratedText`	Imposta un'azione di autorizzazione che apre un URL per il 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 del 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 l'elemento facoltativo `IconImage` visualizzato a destra dei contenuti.
`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 viene fatto clic sull'oggetto.
`setOpenLink(openLink)`	`DecoratedText`	Imposta un URL da aprire quando si fa clic sull'oggetto.
`setStartIcon(startIcon)`	`DecoratedText`	Imposta il carattere facoltativo `IconImage` da visualizzare prima del contenuto del 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 del testo.
`setWrapText(wrapText)`	`DecoratedText`	Imposta 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 per il flusso di autorizzazione quando si fa clic sull'oggetto. L'URL si apre in una nuova finestra. Quando l'utente completa il flusso di autorizzazione e ritorna all'applicazione, il componente aggiuntivo viene ricaricato.

Un oggetto dell'interfaccia utente può avere impostato solo uno tra 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 eseguire quando viene fatto clic su questo elemento.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setBottomLabel(text)`

Imposta 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.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setButton(button)`

Imposta il simbolo 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.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setComposeAction(action, composedEmailType)`

Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto. Un oggetto dell'interfaccia utente 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 ComposeActionResponse configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: questo metodo non imposta un'azione di composizione utilizzata per estendere l'interfaccia utente di composizione. Questo metodo collega questo elemento dell'interfaccia utente a un Action che compone bozze di messaggi in Apps Script che vengono aperte 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 eseguire quando viene fatto clic su questo elemento.
`composedEmailType`	`ComposedEmailType`	Un valore enumerato che specifica se la bozza composta è indipendente o una bozza di risposta.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setEndIcon(endIcon)`

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

Parametri

Nome	Tipo	Descrizione
`endIcon`	`IconImage`	L'icona da aggiungere.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setOnClickAction(action)`

Imposta un'azione da eseguire quando si fa clic sull'oggetto. Un oggetto dell'interfaccia utente 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 eseguire quando viene fatto clic su questo elemento.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`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 intraprendere altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto dell'interfaccia utente 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 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 viene fatto clic su questo elemento.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setOpenLink(openLink)`

Imposta un URL da aprire quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già conosciuto e deve solo essere aperto. Un oggetto dell'interfaccia utente può avere impostato solo uno tra 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.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setStartIcon(startIcon)`

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

Parametri

Nome	Tipo	Descrizione
`startIcon`	`IconImage`	L'icona da visualizzare.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`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'opzione da aggiungere.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setText(text)`

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

Parametri

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

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setTopLabel(text)`

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

Parametri

Nome	Tipo	Descrizione
`text`	`String`	Il testo dell'etichetta.

Invio

DecoratedText: questo oggetto, per l'accodamento.

`setWrapText(wrapText)`

Imposta 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 visualizzato su più righe. In caso contrario, il testo viene troncato.

Invio

DecoratedText: questo oggetto, per l'accodamento.