Class DecoratedText

Dekorowany tekst

Widżet wyświetlający tekst z opcjonalnymi elementami ozdobnymi. Możliwe klucze to między innymi ikona, etykieta powyżej i etykieta poniżej. Ustawienie tekstu i jednego z kluczy wymaga ustawienia setText(text) oraz jednego z DecoratedText, DecoratedText, setTopLabel(text) lub setBottomLabel(text). Ta klasa ma zastąpić właściwość KeyValue.

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var multilineDecoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel")
    .setWrapText(true)
    .setBottomLabel("BottomLabel");

Metody

Metoda	Zwracany typ	Krótki opis
setAuthorizationAction(action)	DecoratedText	Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL procesu autoryzacji.
setBottomLabel(text)	DecoratedText	Ustawia tekst etykiety, który będzie używany jako klucz, wyświetlany pod treścią tekstową.
setButton(button)	DecoratedText	Ustawia element Button wyświetlany po prawej stronie tekstu.
setComposeAction(action, composedEmailType)	DecoratedText	Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setEndIcon(endIcon)	DecoratedText	Ustawia opcjonalny element IconImage wyświetlany po prawej stronie treści.
setOnClickAction(action)	DecoratedText	Ustawia działanie wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)	DecoratedText	Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie.
setOpenLink(openLink)	DecoratedText	Ustawia URL otwierany po kliknięciu obiektu.
setStartIcon(startIcon)	DecoratedText	Ustawia opcjonalny IconImage do wyświetlenia przed tekstem.
setSwitchControl(switchToSet)	DecoratedText	Ustawia element Switch wyświetlany po prawej stronie treści.
setText(text)	DecoratedText	Ustawia tekst, który ma być używany jako wartość.
setTopLabel(text)	DecoratedText	Ustawia tekst etykiety, który będzie używany jako klucz, wyświetlany nad treścią tekstową.
setWrapText(wrapText)	DecoratedText	Określa, czy tekst ma być wyświetlany w jednym czy wielu wierszach.

Szczegółowa dokumentacja

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óć

DecoratedText – ten obiekt do łańcucha.

---

setBottomLabel(text)

Ustawia tekst etykiety, który będzie używany jako klucz, wyświetlany pod treścią tekstową.

Parametry

Nazwa	Typ	Opis
text	String	Tekst etykiety.

Zwróć

DecoratedText – ten obiekt do łańcucha.

---

setButton(button)

Ustawia element Button wyświetlany po prawej stronie tekstu. DecoratedText może obsługiwać tylko 1 przycisk lub 1 przełącznik.

Parametry

Nazwa	Typ	Opis
button	Button	Przycisk dodawania.

Zwróć

DecoratedText – 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óć

DecoratedText – ten obiekt do łańcucha.

---

setEndIcon(endIcon)

Ustawia opcjonalny element IconImage wyświetlany po prawej stronie treści. DecoratedText może obsługiwać tylko 1 przycisk, 1 przełącznik lub 1 ikonę.

Parametry

Nazwa	Typ	Opis
endIcon	IconImage	Ikona do dodania.

Zwróć

DecoratedText – 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óć

DecoratedText – 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óć

DecoratedText – 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óć

DecoratedText – ten obiekt do łańcucha.

---

setStartIcon(startIcon)

Ustawia opcjonalny IconImage do wyświetlenia przed tekstem.

Parametry

Nazwa	Typ	Opis
startIcon	IconImage	Ikona wyświetlana.

Zwróć

DecoratedText – ten obiekt do łańcucha.

---

setSwitchControl(switchToSet)

Ustawia element Switch wyświetlany po prawej stronie treści. DecoratedText może obsługiwać tylko 1 przycisk lub 1 przełącznik.

Parametry

Nazwa	Typ	Opis
switchToSet	Switch	Przełącznik do dodania.

Zwróć

DecoratedText – ten obiekt do łańcucha.

---

setText(text)

Ustawia tekst, który ma być używany jako wartość. Obsługuje podstawowe formatowanie HTML. Wymagany.

Parametry

Nazwa	Typ	Opis
text	String	Zawartość tekstowa tego widżetu.

Zwróć

DecoratedText – ten obiekt do łańcucha.

---

setTopLabel(text)

Ustawia tekst etykiety, który będzie używany jako klucz, wyświetlany nad treścią tekstową.

Parametry

Nazwa	Typ	Opis
text	String	Tekst etykiety.

Zwróć

DecoratedText – ten obiekt do łańcucha.

---

setWrapText(wrapText)

Określa, czy tekst ma być wyświetlany w jednym czy wielu wierszach.

Parametry

Nazwa	Typ	Opis
wrapText	Boolean	W przypadku true tekst jest zawijany i wyświetlany w wielu wierszach tekstu. W przeciwnym razie tekst zostanie skrócony.

Zwróć

DecoratedText – ten obiekt do łańcucha.