Class Button

Button

Podstawowa klasa wszystkich przycisków.

Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.

Metody

Metoda	Zwracany typ	Krótki opis
setAuthorizationAction(action)	Button	Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu.
setComposeAction(action, composedEmailType)	Button	Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila.
setOnClickAction(action)	Button	Określa działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)	Button	Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)	Button	Ustawia adres URL, który zostanie otwarty po kliknięciu obiektu.
setOverflowMenu(menu)	Button	Ustawia menu, które otwiera się po kliknięciu obiektu.

Szczegółowa dokumentacja

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

Nazwa	Typ	Opis
action	AuthorizationAction	Obiekt określający działanie autoryzacyjne, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Button – 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).

Uwaga: ta metoda nie ustawia działania tworzenia, które służy do rozszerzania interfejsu tworzenia. Zamiast tego łączy ten element interfejsu z funkcją Action, która tworzy wersje robocze wiadomości w Apps Script, które po zakończeniu działania są otwierane w Gmailu.

// ...

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();
}

Parametry

Nazwa	Typ	Opis
action	Action	Obiekt określający działanie, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailType	ComposedEmailType	Wartość typu enum określająca, czy skomponowany projekt jest samodzielny czy odpowiedź.

Powrót

Button – 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

Nazwa	Typ	Opis
action	Action	Działanie, które ma być wykonywane po kliknięciu tego elementu.

Powrót

Button – 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 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 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

Nazwa	Typ	Opis
action	Action	Obiekt określający działanie polegające na otwarciu linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Button – ten obiekt do łańcucha.

---

setOpenLink(openLink)

Ustawia adres URL, który zostanie otwarty po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i 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

Nazwa	Typ	Opis
openLink	OpenLink	Obiekt OpenLink opisujący adres URL do otwarcia.

Powrót

Button – ten obiekt do łańcucha.

---

setOverflowMenu(menu)

Ustawia menu, które otwiera się po kliknięciu obiektu. Każdy element w menu może określać działanie, które zostanie wykonane po kliknięciu. Zagnieżdżone menu nie są obsługiwane, a czynności dotyczące pozycji menu nie powinny określać menu przepełnienia.

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

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Parametry

Nazwa	Typ	Opis
menu	OverflowMenu	Obiekt określający menu przepełnienia do wyświetlenia po kliknięciu tego elementu.

Powrót

Button – ten obiekt do łańcucha.