Class TextButton

TextButton

Element TextButton z etykietą tekstową. Możesz ustawić kolor tła i zdezaktywować przycisk w razie potrzeby.

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

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

Metody

MetodaZwracany typKrótki opis
setAltText(altText)TextButtonUstawia alternatywny tekst przycisku na potrzeby ułatwień dostępu.
setAuthorizationAction(action)TextButtonUstawia działanie autoryzacji, które otwiera adres URL w procesie autoryzacji, gdy obiekt kliknięto.
setBackgroundColor(backgroundColor)TextButtonUstawia kolor tła przycisku TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonUstawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu.
setDisabled(disabled)TextButtonOkreśla, czy przycisk ma być wyłączony.
setOnClickAction(action)TextButtonUstawia działanie wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)TextButtonUstawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie.
setOpenLink(openLink)TextButtonUstawia adres URL otwierany po kliknięciu obiektu.
setText(text)TextButtonUstawia tekst, który ma być wyświetlany na przycisku.
setTextButtonStyle(textButtonStyle)TextButtonOkreśla styl przycisku.

Szczegółowa dokumentacja

setAltText(altText)

Ustawia alternatywny tekst przycisku na potrzeby ułatwień dostępu. Jeśli zasada jest nieskonfigurowana, domyślnie używany jest tekst który będzie widoczny na przycisku.

Parametry

NazwaTypOpis
altTextStringTekst alternatywny do przypisania do tego przycisku.

Powrót

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


setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera adres URL w procesie autoryzacji, gdy obiekt kliknięto. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji powróci do aplikacji, dodatek zostanie załadowany ponownie.

Obiekt interfejsu może mieć tylko jedną z wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

// ...

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

Parametry

NazwaTypOpis
actionAuthorizationActionObiekt, który określa działanie autoryzacji, które ma zostać wykonane, gdy ten element jest kliknięto.

Powrót

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


setBackgroundColor(backgroundColor)

Ustawia kolor tła przycisku TextButtonStyle.FILLED. Jeśli przycisk TextButtonStyle.FILLED nie jest ustawiony, używa koloru dodatkowego zdefiniowanego w manifeście dodatku. Ta metoda nie jest obsługiwana w przypadku przycisków TextButtonStyle.OUTLINED.

Parametry

NazwaTypOpis
backgroundColorStringKolor w formacie #rgb.

Powrót

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


setComposeAction(action, composedEmailType)

Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć tylko mają jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), Ustawiono 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).

// ...

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

// ...

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

Parametry

NazwaTypOpis
actionActionObiekt, który określa działanie tworzenia, które ma być wykonywane, gdy ten element jest kliknięto.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa, która określa, czy tworzona wersja robocza to samodzielnej lub roboczej odpowiedzi.

Powrót

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


setDisabled(disabled)

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

Parametry

NazwaTypOpis
disabledBooleanStan wyłączony.

Powrót

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


setOnClickAction(action)

Ustawia działanie wykonywane po kliknięciu obiektu. Obiekt interfejsu użytkownika może mieć tylko jedną z tych wartości: Ustawiono 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.

// ...

var 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

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


setOnClickOpenLinkAction(action)

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

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ActionResponse skonfigurowany za pomocą ActionResponseBuilder.setOpenLink(openLink).

// ...

var 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, który określa działanie otwarcia linku, które ma zostać wykonane, gdy ten element jest kliknięto.

Powrót

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


Ustawia adres URL otwierany po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już i trzeba go tylko otworzyć. Obiekt UI może mieć tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), lub setComposeAction(action, composedEmailType).

Parametry

NazwaTypOpis
openLinkOpenLinkObiekt OpenLink opisujący adres URL, który ma zostać otwarty.

Powrót

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


setText(text)

Ustawia tekst, który ma być wyświetlany na przycisku.

Parametry

NazwaTypOpis
textStringTekst, który wyświetla się na przycisku.

Powrót

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


setTextButtonStyle(textButtonStyle)

Określa styl przycisku. Jeśli zasada jest nieskonfigurowana, domyślna wartość to przycisk TextButtonStyle.OUTLINED.

Parametry

NazwaTypOpis
textButtonStyleTextButtonStyleStyl przycisku.

Powrót

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