Class Chip

Chip

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

Disponibile per le app Google Chat. Nell'anteprima per sviluppatori 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 al 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)ChipDetermina 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 si fa 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 viene impostato, il valore predefinito è il testo visualizzato sul chip.

Parametri

NomeTipoDescrizione
altTextStringIl testo alternativo da assegnare a questo chip.

Indietro

Chip: questo oggetto, per il concatenamento.

setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando si fa clic sull'oggetto. Si apre l'URL in una nuova finestra. Quando l'utente completa il flusso di autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.

Un oggetto UI può avere impostato solo uno dei valori 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 intraprendere quando questo elemento viene cliccato.

Indietro

Chip: questo oggetto, per il concatenamento.

setComposeAction(action, composedEmailType)

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

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 intraprendere quando si fa clic su questo elemento.
composedEmailTypeComposedEmailTypeUn valore enum che specifica se la bozza composta è una bozza autonoma o di risposta.

Indietro

Chip: questo oggetto, per il concatenamento.

setDisabled(disabled)

Determina se il chip è disattivato. Un chip disattivato è visualizzato in grigio e non può essere selezionato. 

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

Parametri

NomeTipoDescrizione
disabledBooleanLo stato disattivato.

Indietro

Chip: questo oggetto, per il concatenamento.

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 predefiniti di IconImage.

Indietro

Chip: questo oggetto, per il concatenamento.

setLabel(label)

Imposta il titolo del chip. Obbligatorio. 

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

Parametri

NomeTipoDescrizione
labelStringIl testo da visualizzare.

Indietro

Chip: questo oggetto, per il concatenamento.

setOnClickAction(action)

Imposta un'azione da eseguire quando si fa clic sull'oggetto. Un oggetto UI 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 intraprendere quando si fa clic su questo elemento.

Indietro

Chip: questo oggetto, per il concatenamento.

setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL deve essere creato o quando devi intraprendere altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto UI può avere impostato solo uno dei seguenti valori: 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 si fa clic su questo elemento.

Indietro

Chip: questo oggetto, per il concatenamento.

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

Parametri

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

Indietro

Chip: questo oggetto, per il concatenamento.