Class TextButton

TextButton

TextButton z etykietą tekstową. W razie potrzeby możesz ustawić kolor tła i dezaktywować przycisk.

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Metody

Metoda	Zwracany typ	Krótki opis
setAltText(altText)	TextButton	Ustawia tekst alternatywny przycisku na potrzeby ułatwień dostępu.
setAuthorizationAction(action)	TextButton	Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu.
setBackgroundColor(backgroundColor)	TextButton	Ustawia kolor tła przycisku TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)	TextButton	Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setDisabled(disabled)	TextButton	Określa, czy przycisk jest wyłączony.
setIcon(icon)	TextButton	Ustawia wstępnie zdefiniowany Icon, który ma być wyświetlany na przycisku.
setIconUrl(url)	TextButton	Ustawia adres URL obrazu, który ma być używany jako ikona tego przycisku.
setMaterialIcon(icon)	TextButton	Umożliwia ustawienie ikony Material Design.
setOnClickAction(action)	TextButton	Ustawia działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)	TextButton	Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)	TextButton	Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu.
setOverflowMenu(menu)	TextButton	Ustawia menu wyskakujące, które ma się otwierać po kliknięciu obiektu.
setText(text)	TextButton	Ustawia tekst wyświetlany na przycisku.
setTextButtonStyle(textButtonStyle)	TextButton	Ustawia styl przycisku.

Szczegółowa dokumentacja

setAltText(altText)

Ustawia tekst alternatywny przycisku na potrzeby ułatwień dostępu. Jeśli nie jest ustawiony, domyślnie jest to tekst wyświetlany na przycisku.

Parametry

Nazwa	Typ	Opis
altText	String	Tekst alternatywny, który ma być przypisany do tego przycisku.

Powrót

TextButton – ten obiekt do łączenia.

---

setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu. URL otworzy się 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 wartości: 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 autoryzacji, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

TextButton – ten obiekt do łączenia.

---

setBackgroundColor(backgroundColor)

Ustawia kolor tła przycisku TextButtonStyle.FILLED. Jeśli w przypadku przycisku TextButtonStyle.FILLED nie jest ustawiony żaden kolor, używa on koloru dodatkowego zdefiniowanego w manifeście dodatku. W przypadku przycisków TextButtonStyle.OUTLINED ta metoda nie wykonuje żadnych działań.

Parametry

Nazwa	Typ	Opis
backgroundColor	String	Kolor w formacie #rgb.

Powrót

TextButton – ten obiekt do łączenia.

---

setComposeAction(action, composedEmailType)

Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną 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 ComposeActionResponse skonfigurowany za pomocą parametru ComposeActionResponseBuilder.setGmailDraft(draft).

Uwaga: ta metoda nie ustawia działania tworzenia, które jest używane do rozszerzania interfejsu tworzenia. Ta metoda łączy element interfejsu z Action, który tworzy 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 określający działanie tworzenia, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailType	ComposedEmailType	Wartość wyliczeniowa określająca, czy utworzona wersja robocza jest wersją roboczą samodzielną czy odpowiedzią.

Powrót

TextButton – ten obiekt do łączenia.

---

setDisabled(disabled)

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

Parametry

Nazwa	Typ	Opis
disabled	Boolean	Stan wyłączony.

Powrót

TextButton – ten obiekt do łączenia.

---

setIcon(icon)

Ustawia wstępnie zdefiniowany Icon, który ma być wyświetlany na przycisku. Do zdefiniowania obrazu przycisku należy użyć tego atrybutu lub atrybutu setIconUrl(url).

Parametry

Nazwa	Typ	Opis
icon	Icon	Jedna ze zdefiniowanych wartości Icon.

Powrót

TextButton – ten obiekt do łączenia.

---

setIconUrl(url)

Ustawia adres URL obrazu, który ma być używany jako ikona tego przycisku. Do zdefiniowania obrazu przycisku należy użyć tego atrybutu lub atrybutu setIcon(icon).

Parametry

Nazwa	Typ	Opis
url	String	Adres URL hostowanego obrazu, który ma być używany jako ikona tego przycisku.

Powrót

TextButton – ten obiekt do łączenia.

---

setMaterialIcon(icon)

Umożliwia ustawienie ikony Material Design.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parametry

Nazwa	Typ	Opis
icon	MaterialIcon	Ikona w stylu Material Design.

Powrót

TextButton – 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 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.

// ...

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 należy wykonać po kliknięciu tego elementu.

Powrót

TextButton – ten obiekt do łączenia.

---

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 wykonać inne działania oprócz utworzenia obiektu OpenLink. Obiekt interfejsu może mieć ustawioną 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ą parametru 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 otwierania linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

TextButton – ten obiekt do łączenia.

---

setOpenLink(openLink)

Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i wystarczy go otworzyć. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: 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

TextButton – ten obiekt do łączenia.

---

setOverflowMenu(menu)

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

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

Wersja przedpremierowa dla programistów: dostępna w ramach programu wersji przedpremierowej 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 do wyświetlenia po kliknięciu tego elementu.

Powrót

TextButton – ten obiekt do łączenia.

---

setText(text)

Ustawia tekst wyświetlany na przycisku.

Parametry

Nazwa	Typ	Opis
text	String	Tekst, który pojawia się na przycisku.

Powrót

TextButton – ten obiekt do łączenia.

---

setTextButtonStyle(textButtonStyle)

Ustawia styl przycisku. Jeśli nie jest ustawiony, domyślnie jest to przycisk TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Parametry

Nazwa	Typ	Opis
textButtonStyle	TextButtonStyle	Styl przycisku.

Powrót

TextButton – ten obiekt do łączenia.