Class DecoratedText

DecoratedText

Widżet, który wyświetla tekst z opcjonalnymi dekoracjami. Możliwe klucze to ikona, etykieta powyżej i etykieta poniżej. Ustawienie treści tekstowej i jednego z kluczy jest wymagane przy użyciu setText(text) i jednego z tych znaków: DecoratedText, DecoratedText, setTopLabel(text) lub setBottomLabel(text). Te zajęcia mają zastąpić KeyValue.

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

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

Metody

Metoda	Zwracany typ	Krótki opis
addEventAction(eventAction)	Widget	Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
setAuthorizationAction(action)	DecoratedText	Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu.
setBottomLabel(text)	DecoratedText	Ustawia tekst etykiety, który będzie używany jako klucz i wyświetlany pod treścią tekstową.
setButton(button)	DecoratedText	Ustawia 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, który jest wyświetlany po prawej stronie treści.
setId(id)	Widget	Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmodyfikowany.
setOnClickAction(action)	DecoratedText	Ustawia działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)	DecoratedText	Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)	DecoratedText	Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu.
setStartIcon(startIcon)	DecoratedText	Ustawia opcjonalny znak IconImage, który ma być wyświetlany przed treścią tekstową.
setSwitchControl(switchToSet)	DecoratedText	Określa Switch, który jest 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 i jest wyświetlany nad treścią tekstową.
setVisibility(visibility)	Widget	Ustawia widoczność widżetu.
setWrapText(wrapText)	DecoratedText	Określa, czy tekst wartości ma być wyświetlany w jednym czy w wielu wierszach.

Szczegółowa dokumentacja

addEventAction(eventAction)

Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.

Parametry

Nazwa	Typ	Opis
eventAction	EventAction	EventAction do dodania.

Powrót

Widget – 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

DecoratedText – ten obiekt do łączenia.

---

setBottomLabel(text)

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

Parametry

Nazwa	Typ	Opis
text	String	Tekst etykiety.

Powrót

DecoratedText – ten obiekt do łączenia.

---

setButton(button)

Ustawia 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.

Powrót

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

DecoratedText – ten obiekt do łączenia.

---

setEndIcon(endIcon)

Ustawia opcjonalny element IconImage, który jest 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.

Powrót

DecoratedText – ten obiekt do łączenia.

---

setId(id)

Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmodyfikowany. Zmiana widżetu jest obsługiwana tylko w dodatkach.

Parametry

Nazwa	Typ	Opis
id	String	Identyfikator widżetu, który może mieć maksymalnie 64 znaki i musi być zgodny z formatem `[a-zA-Z0-9-]+`.

Powrót

Widget – 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

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

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

DecoratedText – ten obiekt do łączenia.

---

setStartIcon(startIcon)

Ustawia opcjonalny znak IconImage, który ma być wyświetlany przed treścią tekstową.

Parametry

Nazwa	Typ	Opis
startIcon	IconImage	Ikona do wyświetlenia.

Powrót

DecoratedText – ten obiekt do łączenia.

---

setSwitchControl(switchToSet)

Określa Switch, który jest 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;

Powrót

DecoratedText – ten obiekt do łączenia.

---

setText(text)

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

Parametry

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

Powrót

DecoratedText – ten obiekt do łączenia.

---

setTopLabel(text)

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

Parametry

Nazwa	Typ	Opis
text	String	Tekst etykiety.

Powrót

DecoratedText – ten obiekt do łączenia.

---

setVisibility(visibility)

Ustawia widoczność widżetu. Wartością domyślną jest „VISIBLE”.

Parametry

Nazwa	Typ	Opis
visibility	Visibility	Visibility widżetu.

Powrót

Widget – obiekt do łączenia.

---

setWrapText(wrapText)

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

Parametry

Nazwa	Typ	Opis
wrapText	Boolean	Jeśli true, tekst jest zawijany i wyświetlany w kilku wierszach. W przeciwnym razie tekst zostanie obcięty.

Powrót

DecoratedText – ten obiekt do łączenia.