Questa pagina è stata tradotta dall'API Cloud Translation.

Class KeyValue

Ritiro. Questa classe è deprecata e non deve essere utilizzata nei nuovi script.

Questa classe è deprecata. Utilizza invece DecoratedText.

Metodi

Metodo	Tipo restituito	Breve descrizione
`setAuthorizationAction(action)`	`KeyValue`	Imposta un'azione di autorizzazione che apre un URL per il flusso di autorizzazione quando si fa clic sull'oggetto.
`setComposeAction(action, composedEmailType)`	`KeyValue`	Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto.
`setOnClickAction(action)`	`KeyValue`	Imposta un'azione da eseguire quando si fa clic sull'oggetto.
`setOnClickOpenLinkAction(action)`	`KeyValue`	Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto.
`setOpenLink(openLink)`	`KeyValue`	Imposta un URL da aprire quando si fa clic sull'oggetto.

Metodi ritirati

Metodo	Tipo restituito	Breve descrizione
`setBottomLabel(text)`	`KeyValue`	Imposta il testo dell'etichetta da utilizzare come chiave.
`setButton(button)`	`KeyValue`	Imposta il `Button` visualizzato a destra del contesto.
`setContent(text)`	`KeyValue`	Imposta il testo da utilizzare come valore.
`setIcon(icon)`	`KeyValue`	Imposta l'icona da utilizzare come chiave.
`setIconAltText(altText)`	`KeyValue`	Imposta il testo alternativo per l'icona.
`setIconUrl(url)`	`KeyValue`	Imposta l'URL dell'icona da utilizzare come chiave.
`setMultiline(multiline)`	`KeyValue`	Imposta se il testo del valore deve essere visualizzato su una singola riga o su più righe.
`setSwitch(switchToSet)`	`KeyValue`	Imposta il `Switch` visualizzato a destra dei contenuti.
`setTopLabel(text)`	`KeyValue`	Imposta il testo dell'etichetta da utilizzare come chiave.

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

KeyValue: 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

KeyValue: 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

KeyValue: 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

KeyValue: 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

KeyValue: questo oggetto, per l'accodamento.

Metodi ritirati

`setBottomLabel(text)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta il testo dell'etichetta da utilizzare come chiave. Viene visualizzato sotto il testo.

Parametri

Nome	Tipo	Descrizione
`text`	`String`	Il testo dell'etichetta. Nota: non supporta la formattazione HTML di base.

Invio

KeyValue: questo oggetto, per l'accodamento.

`setButton(button)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta il Button visualizzato a destra del contesto. Un KeyValue può supportare solo un pulsante, un interruttore o un'icona.

Parametri

Nome	Tipo	Descrizione
`button`	`Button`	Il pulsante per aggiungere.

Invio

KeyValue: questo oggetto, per l'accodamento.

`setContent(text)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

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

KeyValue: questo oggetto, per l'accodamento.

`setIcon(icon)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta l'icona da utilizzare come chiave.

Parametri

Nome	Tipo	Descrizione
`icon`	`Icon`	Uno dei valori `Icon` predefiniti.

Invio

KeyValue: questo oggetto, per l'accodamento.

`setIconAltText(altText)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta il testo alternativo per l'icona.

Parametri

Nome	Tipo	Descrizione
`altText`	`String`	Il testo alternativo per l'icona.

Invio

KeyValue: questo oggetto, per l'accodamento.

`setIconUrl(url)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta l'URL dell'icona da utilizzare come chiave.

Parametri

Nome	Tipo	Descrizione
`url`	`String`	L'indirizzo URL di un'immagine ospitata da utilizzare come icona.

Invio

KeyValue: questo oggetto, per l'accodamento.

`setMultiline(multiline)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta se il testo del valore deve essere visualizzato su una singola riga o su più righe.

Parametri

Nome	Tipo	Descrizione
`multiline`	`Boolean`	L'impostazione multiline.

Invio

KeyValue: questo oggetto, per l'accodamento.

`setSwitch(switchToSet)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

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

Parametri

Nome	Tipo	Descrizione
`switchToSet`	`Switch`	L'opzione da aggiungere.

Invio

KeyValue: questo oggetto, per l'accodamento.

`setTopLabel(text)`

Ritiro. Questa funzione è deprecata e non deve essere utilizzata nei nuovi script.

Imposta il testo dell'etichetta da utilizzare come chiave. Viene visualizzato sopra il testo.

Parametri

Nome	Tipo	Descrizione
`text`	`String`	Il testo dell'etichetta. Nota: non supporta la formattazione HTML di base.

Invio

KeyValue: questo oggetto, per l'accodamento.