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

MetodaZwracany typKrótki opis
addEventAction(eventAction)WidgetDodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
setAuthorizationAction(action)DecoratedTextUstawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu.
setBottomLabel(text)DecoratedTextUstawia tekst etykiety, który będzie używany jako klucz i wyświetlany pod treścią tekstową.
setButton(button)DecoratedTextUstawia Button wyświetlany po prawej stronie tekstu.
setComposeAction(action, composedEmailType)DecoratedTextUstawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setEndIcon(endIcon)DecoratedTextUstawia opcjonalny element IconImage, który jest wyświetlany po prawej stronie treści.
setId(id)WidgetUstawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony.
setOnClickAction(action)DecoratedTextUstawia działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)DecoratedTextUstawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)DecoratedTextUstawia adres URL, który ma się otworzyć po kliknięciu obiektu.
setStartIcon(startIcon)DecoratedTextUstawia opcjonalny znak IconImage, który ma być wyświetlany przed treścią tekstową.
setSwitchControl(switchToSet)DecoratedTextOkreśla Switch wyświetlany po prawej stronie treści.
setText(text)DecoratedTextUstawia tekst, który ma być używany jako wartość.
setTopLabel(text)DecoratedTextUstawia tekst etykiety, który będzie używany jako klucz i jest wyświetlany nad treścią tekstową.
setVisibility(visibility)WidgetUstawia widoczność widżetu.
setWrapText(wrapText)DecoratedTextOkreś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

NazwaTypOpis
eventActionEventActionEventAction 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

NazwaTypOpis
actionAuthorizationActionObiekt 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

NazwaTypOpis
textStringTekst 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

NazwaTypOpis
buttonButtonPrzycisk 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ą ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

NazwaTypOpis
actionActionObiekt określający działanie tworzenia, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa określająca, czy utworzony projekt jest projektem samodzielnym czy projektem 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

NazwaTypOpis
endIconIconImageIkona do dodania.

Powrót

DecoratedText – ten obiekt do łączenia.


setId(id)

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

Parametry

NazwaTypOpis
idStringIdentyfikator 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

NazwaTypOpis
actionActionDział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 adres URL musi zostać utworzony lub gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne działania. 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ą 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

NazwaTypOpis
actionActionObiekt określający działanie otwierania linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

DecoratedText – ten obiekt do łączenia.


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

NazwaTypOpis
openLinkOpenLinkObiekt 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

NazwaTypOpis
startIconIconImageIkona do wyświetlenia.

Powrót

DecoratedText – ten obiekt do łączenia.


setSwitchControl(switchToSet)

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

Parametry

NazwaTypOpis
switchToSetSwitchPrzełą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

NazwaTypOpis
textStringZawartość 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

NazwaTypOpis
textStringTekst etykiety.

Powrót

DecoratedText – ten obiekt do łączenia.


setVisibility(visibility)

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

Parametry

NazwaTypOpis
visibilityVisibilityVisibility 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

NazwaTypOpis
wrapTextBooleanJeśli true, tekst jest zawijany i wyświetlany w wielu wierszach. W przeciwnym razie tekst zostanie obcięty.

Powrót

DecoratedText – ten obiekt do łączenia.