Ta strona została przetłumaczona przez Cloud Translation API.

Class TextButton

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

Metoda	Zwracany typ	Krótki opis
`setAltText(altText)`	`TextButton`	Ustawia alternatywny tekst przycisku.
`setAuthorizationAction(action)`	`TextButton`	Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL procesu autoryzacji.
`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.
`setOnClickAction(action)`	`TextButton`	Ustawia działanie wykonywane po kliknięciu obiektu.
`setOnClickOpenLinkAction(action)`	`TextButton`	Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie.
`setOpenLink(openLink)`	`TextButton`	Ustawia URL otwierany po kliknięciu obiektu.
`setText(text)`	`TextButton`	Ustawia tekst na przycisku.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Ustawia 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

Nazwa	Typ	Opis
`altText`	`String`	Tekst 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

Nazwa	Typ	Opis
`action`	`AuthorizationAction`	Obiekt, 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

Nazwa	Typ	Opis
`backgroundColor`	`String`	Kolor 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).

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

// ...

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

Nazwa	Typ	Opis
`action`	`Action`	Obiekt określający działanie tworzenia wiadomości po kliknięciu tego elementu.
`composedEmailType`	`ComposedEmailType`	Wartość 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

Nazwa	Typ	Opis
`disabled`	`Boolean`	Stan 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

Nazwa	Typ	Opis
`action`	`Action`	Dział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

Nazwa	Typ	Opis
`action`	`Action`	Obiekt, który określa działanie linku otwartego po kliknięciu tego elementu.

Zwróć

TextButton – ten obiekt do łańcucha.

`setOpenLink(openLink)`

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

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

Zwróć

TextButton – ten obiekt do łańcucha.

`setText(text)`

Ustawia tekst na przycisku.

Parametry

Nazwa	Typ	Opis
`text`	`String`	Tekst 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

Nazwa	Typ	Opis
`textButtonStyle`	`TextButtonStyle`	Styl przycisku.

Zwróć

TextButton – ten obiekt do łańcucha.