Class TextButton

Przycisk Tekst

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

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.
setAuthorizationAction(action)TextButtonUstawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL procesu autoryzacji.
setBackgroundColor(backgroundColor)TextButtonUstawia kolor tła przycisku TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonUstawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setDisabled(disabled)TextButtonOkreśla, czy przycisk jest 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 URL otwierany po kliknięciu obiektu.
setText(text)TextButtonUstawia tekst na przycisku.
setTextButtonStyle(textButtonStyle)TextButtonUstawia styl przycisku.

Szczegółowa dokumentacja

setAltText(altText)

Ustawia alternatywny tekst przycisku. Jeśli zasada jest nieskonfigurowana, domyślnie jest wyświetlany tekst wyświetlany na przycisku.

Parametry

NazwaTypOpis
altTextStringTekst alternatywny do przypisania do tego przycisku.

Zwróć

TextButton – ten obiekt do łańcucha.


setAuthorizationAction(action)

Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL 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 wczytany.

Obiekt interfejsu może mieć ustawiony tylko jeden z tych atrybutów: 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 wykonywane po kliknięciu tego elementu.

Zwróć

TextButton – ten obiekt do łańcucha.


setBackgroundColor(backgroundColor)

Ustawia kolor tła przycisku TextButtonStyle.FILLED. Jeśli przycisk TextButtonStyle.FILLED nie jest skonfigurowany, używany jest kolor dodatkowy zdefiniowany w pliku manifestu dodatku. Ta metoda nie obsługuje przycisków TextButtonStyle.TEXT.

Parametry

NazwaTypOpis
backgroundColorStringKolor w formacie #vertical.

Zwróć

TextButton – ten obiekt do łańcucha.


setComposeAction(action, composedEmailType)

Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć ustawiony 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 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 określający działanie tworzenia wiadomości po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa, która określa, czy stworzona wersja robocza jest wersją samodzielną czy roboczą odpowiedzi.

Zwróć

TextButton – ten obiekt do łańcucha.


setDisabled(disabled)

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

Parametry

NazwaTypOpis
disabledBooleanStan wyłączenia.

Zwróć

TextButton – ten obiekt do łańcucha.


setOnClickAction(action)

Ustawia działanie wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć ustawiony tylko 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, które ma zostać wykonane po kliknięciu tego elementu.

Zwróć

TextButton – ten obiekt do łańcucha.


setOnClickOpenLinkAction(action)

Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie. Używaj tej funkcji, gdy musisz utworzyć adres URL lub wykonać dodatkowe działania, aby utworzyć obiekt OpenLink. Obiekt interfejsu może mieć ustawiony tylko 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).

// ...

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 linku otwartego po kliknięciu tego elementu.

Zwróć

TextButton – ten obiekt do łańcucha.


Ustawia URL otwierany po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i tylko trzeba go otworzyć. Obiekt interfejsu może mieć ustawiony tylko 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.

Zwróć

TextButton – ten obiekt do łańcucha.


setText(text)

Ustawia tekst na przycisku.

Parametry

NazwaTypOpis
textStringTekst na przycisku.

Zwróć

TextButton – ten obiekt do łańcucha.


setTextButtonStyle(textButtonStyle)

Ustawia styl przycisku. Jeśli zasada jest nieskonfigurowana, domyślną wartością jest przycisk TextButtonStyle.TEXT.

Parametry

NazwaTypOpis
textButtonStyleTextButtonStyleStyl przycisku.

Zwróć

TextButton – ten obiekt do łańcucha.