Class Chip

Procesor

Element Chip z ikoną i etykietą tekstową. W razie potrzeby możesz dezaktywować element.

Dostępne tylko w przypadku aplikacji Google Chat. Niedostępne w przypadku dodatków Google Workspace.

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

Metody

MetodaZwracany typKrótki opis
setAltText(altText)ChipUstawia tekst zastępczy elementu mapy w celu ułatwienia dostępu.
setAuthorizationAction(action)ChipUstawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu.
setComposeAction(action, composedEmailType)ChipPo kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila.
setDisabled(disabled)ChipOkreśla, czy moduł jest wyłączony.
setIcon(icon)ChipUstawia ikonę, która będzie używana jako element.
setLabel(label)ChipUstawia tytuł elementu.
setOnClickAction(action)ChipUstawia działanie wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)ChipUstawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)ChipUstawia adres URL, który zostanie otwarty po kliknięciu obiektu.

Szczegółowa dokumentacja

setAltText(altText)

Ustawia tekst zastępczy elementu mapy w celu ułatwienia dostępu. Jeśli zasada jest nieskonfigurowana, domyślnie używany jest tekst wyświetlany na elemencie.

Parametry

NazwaTypOpis
altTextStringTekst zastępczy do przypisania do tego elementu.

Powrót

Chip – ten obiekt do łańcucha.


setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i powróci do aplikacji, wtyczka zostanie ponownie załadowana.

Obiekt interfejsu może mieć tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametry

NazwaTypOpis
actionAuthorizationActionObiekt określający działanie autoryzacyjne, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Chip – ten obiekt do łańcucha.


setComposeAction(action, composedEmailType)

Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila. Obiekt interfejsu może mieć tylko jedną z tych przeglądarek: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ComposeActionResponse skonfigurowany za pomocą ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parametry

NazwaTypOpis
actionActionObiekt określający działanie, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość typu enumeracji określająca, czy skomponowany projekt jest samodzielny czy jest odpowiedzią na inny projekt.

Powrót

Chip – ten obiekt do łańcucha.


setDisabled(disabled)

Określa, czy moduł jest wyłączony. Wyłączony element jest wyszarzony i nie można go kliknąć.

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

Parametry

NazwaTypOpis
disabledBooleanStan wyłączony.

Powrót

Chip – ten obiekt do łańcucha.


setIcon(icon)

Ustawia ikonę, która będzie używana jako element.

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

Parametry

NazwaTypOpis
iconIconImagejedną z wstępnie zdefiniowanych wartości IconImage.

Powrót

Chip – ten obiekt do łańcucha.


setLabel(label)

Ustawia tytuł elementu. Wymagane.

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

Parametry

NazwaTypOpis
labelStringTekst do wyświetlenia.

Powrót

Chip – ten obiekt do łańcucha.


setOnClickAction(action)

Określa działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt 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();
}

Parametry

NazwaTypOpis
actionActionDziałanie, jakie ma zostać wykonane po kliknięciu tego elementu.

Powrót

Chip – ten obiekt do łańcucha.


setOnClickOpenLinkAction(action)

Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu. Użyj tej funkcji, gdy musisz utworzyć adres URL lub gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne czynności. Obiekt interfejsu może mieć tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ActionResponse skonfigurowany za pomocą 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();
}

Parametry

NazwaTypOpis
actionActionObiekt określający działanie polegające na otwarciu linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Chip – ten obiekt do łańcucha.


Ustawia adres URL otwierany po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany, ale trzeba go tylko otworzyć. Obiekt interfejsu może mieć tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametry

NazwaTypOpis
openLinkOpenLinkObiekt OpenLink opisujący adres URL do otwarcia.

Powrót

Chip – obiekt do tworzenia łańcuchów.