Class KeyValue

KeyValue

Obsoleta. Questo corso è deprecato e non deve essere utilizzato in nuovi script.

Questo corso è stato ritirato. Usa invece DecoratedText.

Metodi

MetodoTipo restituitoBreve descrizione
setAuthorizationAction(action)KeyValueImposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato.
setComposeAction(action, composedEmailType)KeyValueImposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto.
setOnClickAction(action)KeyValueImposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto.
setOnClickOpenLinkAction(action)KeyValueConsente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto.
setOpenLink(openLink)KeyValueImposta un URL da aprire quando l'utente fa clic sull'oggetto.

Documentazione dettagliata

setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato. L'URL viene aperto in una nuova finestra. Quando l'utente termina il flusso di autorizzazione all'applicazione, il componente aggiuntivo si ricarica.

Per un oggetto UI può essere impostato un solo elemento 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

NomeTipoDescrizione
actionAuthorizationActionL'oggetto che specifica l'azione di autorizzazione da eseguire quando questo elemento viene selezionato.

Invio

KeyValue: oggetto per il collegamento.

setComposeAction(action, composedEmailType)

Imposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto. Un oggetto UI può solo avere uno dei seguenti: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Il parametro Action deve specificare una funzione di callback che restituisca 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

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di scrittura da eseguire quando questo elemento viene selezionato.
composedEmailTypeComposedEmailTypeUn valore enum che specifica se la bozza composta è un indipendente o una bozza di risposta.

Invio

KeyValue: oggetto per il collegamento.

setOnClickAction(action)

Imposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto. Un oggetto UI può avere solo uno dei seguenti Impostazione setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostata.

Il parametro Action deve specificare una funzione di callback che restituisca 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

NomeTipoDescrizione
actionActionL'azione da eseguire quando l'utente fa clic su questo elemento.

Invio

KeyValue: oggetto per il collegamento.

setOnClickOpenLinkAction(action)

Consente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando È necessario creare l'URL o quando devi eseguire altre azioni oltre alla creazione dell'oggetto OpenLink. 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 restituisca 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

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di apertura link da eseguire quando questo elemento è selezionato.

Invio

KeyValue: oggetto per il collegamento.

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

Parametri

NomeTipoDescrizione
openLinkOpenLinkUn oggetto OpenLink che descrive l'URL da aprire.

Invio

KeyValue: oggetto per il collegamento.

Metodi deprecati