Class Button

Button

Klasa bazowa dla 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 po kliknięciu obiektu otwiera adres URL do procesu autoryzacji.
setComposeAction(action, composedEmailType)	Button	Ustawia działanie, które po kliknięciu obiektu tworzy wersję roboczą e-maila.
setOnClickAction(action)	Button	Ustawia działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)	Button	Ustawia działanie, które po kliknięciu obiektu otwiera adres URL w karcie.
setOpenLink(openLink)	Button	Ustawia adres URL, który ma zostać otwarty po kliknięciu obiektu.
setOverflowMenu(menu)	Button	Ustawia menu wyskakujące, które ma zostać otwarte po kliknięciu obiektu.

Szczegółowa dokumentacja

setAuthorizationAction(action)

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

Obiekt interfejsu może mieć ustawioną tylko jedną z tych metod: 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, który określa działanie autoryzacji, jakie ma zostać wykonane po kliknięciu tego elementu.

Powrót

Button – ten obiekt do łączenia.

---

setComposeAction(action, composedEmailType)

Ustawia działanie, które po kliknięciu obiektu tworzy wersję roboczą e-maila. Obiekt interfejsu może mieć ustawioną tylko jedną z tych metod: 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 jest używane do rozszerzania interfejsu tworzenia. Łączy ona ten element interfejsu z Action która tworzy wersje robocze wiadomości w Apps Script, które są otwierane w Gmailu po zakończeniu działania.

// ...

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, który określa działanie tworzenia, jakie ma zostać wykonane po kliknięciu tego elementu.
composedEmailType	ComposedEmailType	Wartość wyliczenia, która określa, czy utworzona wersja robocza jest samodzielna, czy jest odpowiedzią.

Powrót

Button – ten obiekt do łączenia.

---

setOnClickAction(action)

Ustawia działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych metod: 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 zostać wykonane po kliknięciu tego elementu.

Powrót

Button – ten obiekt do łączenia.

---

setOnClickOpenLinkAction(action)

Ustawia działanie, które po kliknięciu obiektu otwiera adres URL w karcie. Użyj tej funkcji, gdy trzeba utworzyć adres URL lub gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne działania. Obiekt interfejsu może mieć ustawioną tylko jedną z tych metod: 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, który określa działanie otwierania linku, jakie ma zostać wykonane po kliknięciu tego elementu.

Powrót

Button – ten obiekt do łączenia.

---

setOpenLink(openLink)

Ustawia adres URL, który ma zostać 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ć ustawioną tylko jedną z tych metod: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametry

Nazwa	Typ	Opis
openLink	OpenLink	Obiekt OpenLink opisujący adres URL, który ma zostać otwarty.

Powrót

Button – ten obiekt do łączenia.

---

setOverflowMenu(menu)

Ustawia menu wyskakujące, które ma zostać otwarte po kliknięciu obiektu. Każdy element menu może określać działanie, które ma zostać wywołane po kliknięciu. Menu zagnieżdżone nie są obsługiwane, a działania dotyczące elementów menu nie powinny określać rozszerzonego menu.

Dostępne w przypadku aplikacji Google Chat. W wersji testowej dla deweloperów dodatków do Google Workspace.

Wersja przedpremierowa dla programistów: dostępna w ramach Programu testowania aktualizacji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji.

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, który określa rozszerzone menu, jakie ma zostać wyświetlone po kliknięciu tego elementu.

Powrót

Button – ten obiekt do łączenia.