Class CardAction

SchedaAzione

Una voce di menu cliccabile aggiunta al menu dell'intestazione della scheda.

const action = CardService.newAction();
// Finish building the action...

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

Metodi

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

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

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

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

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

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

CardAction: questo oggetto, per l'accodamento.

---

setText(text)

Imposta il testo del menu per questa azione.

Parametri

Nome	Tipo	Descrizione
text	String	Il testo della voce di menu.

Invio

CardAction: questo oggetto, per l'accodamento.