Class Chip

Chip

Un Chip con un'icona e un'etichetta di testo. Puoi disattivare il chip quando necessario.

Disponibile solo per le app Google Chat. Non disponibile per i componenti aggiuntivi di Google Workspace.

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

Metodi

MetodoTipo restituitoBreve descrizione
setAltText(altText)ChipImposta il testo alternativo del chip per l'accessibilità.
setAuthorizationAction(action)ChipImposta un'azione di autorizzazione che apre un URL per il flusso di autorizzazione quando si fa clic sull'oggetto.
setComposeAction(action, composedEmailType)ChipImposta un'azione che compone una bozza di email quando si fa clic sull'oggetto.
setDisabled(disabled)ChipImposta se il chip è disattivato.
setIcon(icon)ChipImposta l'icona da utilizzare come chip.
setLabel(label)ChipImposta il titolo del chip.
setOnClickAction(action)ChipImposta un'azione da eseguire quando si fa clic sull'oggetto.
setOnClickOpenLinkAction(action)ChipImposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto.
setOpenLink(openLink)ChipImposta un URL da aprire quando si fa clic sull'oggetto.

Documentazione dettagliata

setAltText(altText)

Imposta il testo alternativo del chip per l'accessibilità. Se non impostato, viene utilizzato il testo visualizzato sul chip.

Parametri

NomeTipoDescrizione
altTextStringIl testo alternativo da assegnare a questo chip.

Invio

Chip: questo oggetto, per l'accodamento.


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

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

Invio

Chip: 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).

// ...

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

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di composizione da eseguire quando viene fatto clic su questo elemento.
composedEmailTypeComposedEmailTypeUn valore enumerato che specifica se la bozza composta è indipendente o una bozza di risposta.

Invio

Chip: questo oggetto, per l'accodamento.


setDisabled(disabled)

Imposta se il chip è disattivato. Un chip disattivato non è selezionabile ed è visualizzato in grigio.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

Parametri

NomeTipoDescrizione
disabledBooleanLo stato disattivato.

Invio

Chip: questo oggetto, per l'accodamento.


setIcon(icon)

Imposta l'icona da utilizzare come chip.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

Parametri

NomeTipoDescrizione
iconIconImageUno dei valori IconImage predefiniti.

Invio

Chip: questo oggetto, per l'accodamento.


setLabel(label)

Imposta il titolo del chip. Obbligatorio.

const chip = CardService.newChip().setLabel('bug Report');

Parametri

NomeTipoDescrizione
labelStringIl testo da visualizzare.

Invio

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

NomeTipoDescrizione
actionActionL'azione da eseguire quando viene fatto clic su questo elemento.

Invio

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

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di apertura del link da eseguire quando viene fatto clic su questo elemento.

Invio

Chip: questo oggetto, per l'accodamento.


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

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

Invio

Chip: questo oggetto, per l'accodamento.