Class DecoratedText

DecoratedText

Widżet wyświetlający tekst z opcjonalnymi dekoracjami. Możliwe klucze obejmują ikonę, etykietę powyżej i etykietę poniżej. Ustawienie zawartości tekstowej i jednego z kluczy jest wymagane za pomocą funkcji setText(text) i jednego z tych elementów: DecoratedText, DecoratedText, setTopLabel(text) lub setBottomLabel(text). Ta klasa ma zastąpić element KeyValue.

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

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

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

Metody

MetodaZwracany typKrótki opis
setAuthorizationAction(action)DecoratedTextUstawia działanie autoryzacji, które otwiera adres URL w procesie autoryzacji, gdy obiekt kliknięto.
setBottomLabel(text)DecoratedTextOkreśla tekst etykiety, który będzie używany jako klucz i będzie wyświetlany pod treścią tekstową.
setButton(button)DecoratedTextUstawia element Button wyświetlany z prawej strony tekstu.
setComposeAction(action, composedEmailType)DecoratedTextUstawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu.
setEndIcon(endIcon)DecoratedTextOkreśla opcjonalny element IconImage wyświetlany po prawej stronie treści.
setOnClickAction(action)DecoratedTextUstawia działanie wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)DecoratedTextUstawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie.
setOpenLink(openLink)DecoratedTextUstawia adres URL otwierany po kliknięciu obiektu.
setStartIcon(startIcon)DecoratedTextOkreśla, czy opcjonalny element IconImage ma być wyświetlany przed treścią tekstową.
setSwitchControl(switchToSet)DecoratedTextUstawia element Switch wyświetlany po prawej stronie treści.
setText(text)DecoratedTextUstawia tekst, który ma być używany jako wartość.
setTopLabel(text)DecoratedTextOkreśla tekst etykiety, który ma być używany jako klucz i jest wyświetlany nad treścią tekstową.
setWrapText(wrapText)DecoratedTextOkreśla, czy tekst wartości ma się wyświetlać w jednym czy w wielu wierszach.

Szczegółowa dokumentacja

setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera adres URL w procesie autoryzacji, gdy obiekt kliknięto. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji powróci do aplikacji, dodatek zostanie załadowany ponownie.

Obiekt interfejsu może mieć tylko jedną z wartości: 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, które ma zostać wykonane, gdy ten element jest kliknięto.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setBottomLabel(text)

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

Parametry

NazwaTypOpis
textStringTekst etykiety.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setButton(button)

Ustawia element Button wyświetlany z prawej strony tekstu. DecoratedText może obsługują tylko jeden przycisk lub jeden przełącznik.

Parametry

NazwaTypOpis
buttonButtonPrzycisk dodawania.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setComposeAction(action, composedEmailType)

Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć tylko mają jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), Ustawiono 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, który określa działanie tworzenia, które ma być wykonywane, gdy ten element jest kliknięto.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa, która określa, czy tworzona wersja robocza to samodzielnej lub roboczej odpowiedzi.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setEndIcon(endIcon)

Określa 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

NazwaTypOpis
endIconIconImageIkona do dodania.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setOnClickAction(action)

Ustawia działanie wykonywane po kliknięciu obiektu. Obiekt interfejsu użytkownika może mieć tylko jedną z tych wartości: Ustawiono 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, jakie ma zostać wykonane po kliknięciu tego elementu.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setOnClickOpenLinkAction(action)

Ustawia działanie, które po kliknięciu obiektu otwiera adres URL na karcie. Użyj tej funkcji, gdy Musisz utworzyć adres URL lub wykonać inne działania oprócz utworzenia obiektu OpenLink. Obiekt UI może mieć tylko jedną z tych wartości: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub Ustawiono 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 otwarcia linku, które ma zostać wykonane, gdy ten element jest kliknięto.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


Ustawia adres URL otwierany po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już i trzeba go tylko otworzyć. Obiekt UI może mieć 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, który ma zostać otwarty.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setStartIcon(startIcon)

Określa, czy opcjonalny element IconImage ma być wyświetlany przed treścią tekstową.

Parametry

NazwaTypOpis
startIconIconImageIkona do wyświetlenia.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setSwitchControl(switchToSet)

Ustawia element Switch wyświetlany po prawej stronie treści. DecoratedText obsługuje tylko 1 przycisk lub 1 przełącznik.

Parametry

NazwaTypOpis
switchToSetSwitchPrzełącznik dodawania.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


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 – obiekt do tworzenia łańcuchów.


setTopLabel(text)

Określa tekst etykiety, który ma być używany jako klucz i jest wyświetlany nad treścią tekstową.

Parametry

NazwaTypOpis
textStringTekst etykiety.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.


setWrapText(wrapText)

Określa, czy tekst wartości ma się wyświetlać w jednym czy w wielu wierszach.

Parametry

NazwaTypOpis
wrapTextBooleanJeśli używasz wartości true, tekst jest zawijany i wyświetlany w wielu wierszach. W przeciwnym razie tekst jest obcięty.

Powrót

DecoratedText – obiekt do tworzenia łańcuchów.