Questa pagina è stata tradotta dall'API Cloud Translation.

Class 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

Metodo	Tipo restituito	Breve descrizione
`setAltText(altText)`	`Chip`	Imposta il testo alternativo del chip per l'accessibilità.
`setAuthorizationAction(action)`	`Chip`	Imposta un'azione di autorizzazione che apre un URL per il flusso di autorizzazione quando si fa clic sull'oggetto.
`setComposeAction(action, composedEmailType)`	`Chip`	Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto.
`setDisabled(disabled)`	`Chip`	Imposta se il chip è disattivato.
`setIcon(icon)`	`Chip`	Imposta l'icona da utilizzare come chip.
`setLabel(label)`	`Chip`	Imposta il titolo del chip.
`setOnClickAction(action)`	`Chip`	Imposta un'azione da eseguire quando si fa clic sull'oggetto.
`setOnClickOpenLinkAction(action)`	`Chip`	Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto.
`setOpenLink(openLink)`	`Chip`	Imposta 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

Nome	Tipo	Descrizione
`altText`	`String`	Il 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

Nome	Tipo	Descrizione
`action`	`AuthorizationAction`	L'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).

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

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

Nome	Tipo	Descrizione
`disabled`	`Boolean`	Lo 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

Nome	Tipo	Descrizione
`icon`	`IconImage`	Uno 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

Nome	Tipo	Descrizione
`label`	`String`	Il 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

Nome	Tipo	Descrizione
`action`	`Action`	L'azione da intraprendere 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

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

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

Chip: questo oggetto, per l'accodamento.