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

Class DecoratedText

Widżet wyświetlający tekst z opcjonalnymi ozdobnikami. Możliwe klucze to ikona, etykieta powyżej i etykieta poniżej. Ustawienie treści tekstowej i jednego z kluczy jest wymagane za pomocą setText(text) i jednego z tych kluczy: DecoratedText, DecoratedText, setTopLabel(text) lub setBottomLabel(text). Te zajęcia mają zastąpić zajęcia KeyValue.

Dostępne w przypadku dodatków do Google Workspace i aplikacji 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
`setAuthorizationAction(action)`	`DecoratedText`	Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu.
`setBottomLabel(text)`	`DecoratedText`	Ustawia tekst etykiety, który ma być używany jako klucz, i wyświetla go pod treścią.
`setButton(button)`	`DecoratedText`	Ustawia `Button`, który jest wyświetlany po prawej stronie tekstu.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila.
`setEndIcon(endIcon)`	`DecoratedText`	Ustawia opcjonalną wartość `IconImage`, która wyświetla się po prawej stronie treści.
`setOnClickAction(action)`	`DecoratedText`	Określa 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 zostanie otwarty po kliknięciu obiektu.
`setStartIcon(startIcon)`	`DecoratedText`	Ustawia opcjonalny element `IconImage` do wyświetlania przed treścią tekstową.
`setSwitchControl(switchToSet)`	`DecoratedText`	Ustawia `Switch`, który jest wyświetlany po prawej stronie treści.
`setText(text)`	`DecoratedText`	Określa tekst, który ma być używany jako wartość.
`setTopLabel(text)`	`DecoratedText`	Ustawia tekst etykiety, który ma być używany jako klucz i wyświetlany nad treścią.
`setWrapText(wrapText)`	`DecoratedText`	Określa, czy tekst wartości ma być wyświetlany na jednym czy na kilku wierszach.

Szczegółowa dokumentacja

`setAuthorizationAction(action)`

Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, wtyczka zostanie ponownie załadowana.

Obiekt interfejsu może mieć tylko jeden z tych parametrów: 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 autoryzacyjne, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

DecoratedText – ten obiekt do łańcucha.

`setBottomLabel(text)`

Ustawia tekst etykiety, który ma być używany jako klucz. Etykieta jest wyświetlana pod tekstem treści.

Parametry

Nazwa	Typ	Opis
`text`	`String`	Tekst etykiety.

Powrót

DecoratedText – ten obiekt do łańcucha.

`setButton(button)`

Ustawia Button, który jest wyświetlany po prawej stronie tekstu. DecoratedText może obsługiwać tylko jeden przycisk lub jeden przełącznik.

Parametry

Nazwa	Typ	Opis
`button`	`Button`	Przycisk dodawania.

Powrót

DecoratedText – ten obiekt do łańcucha.

`setComposeAction(action, composedEmailType)`

Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila. Obiekt interfejsu może mieć tylko jedną z tych przeglądarek: 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, które służy do rozszerzania interfejsu tworzenia. Zamiast tego łączy ten element interfejsu użytkownika z funkcją Action, która tworzy kopie robocze wiadomości w Apps Script, które po zakończeniu działania są otwierane w Gmailu.

// ...

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, które ma zostać wykonane po kliknięciu tego elementu.
`composedEmailType`	`ComposedEmailType`	Wartość typu enumeracji określająca, czy skomponowany projekt jest samodzielny czy jest odpowiedzią na inny projekt.

Powrót

DecoratedText – ten obiekt do łańcucha.

`setEndIcon(endIcon)`

Ustawia opcjonalną wartość IconImage, która wyświetla się po prawej stronie treści. DecoratedText może zawierać tylko 1 przycisk, 1 przełącznik lub 1 ikonę.

Parametry

Nazwa	Typ	Opis
`endIcon`	`IconImage`	Ikona do dodania.

Powrót

DecoratedText – ten obiekt do łańcucha.

`setOnClickAction(action)`

Określa działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć 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 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 ma być wykonywane po kliknięciu tego elementu.

Powrót

DecoratedText – ten obiekt do łańcucha.

`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 gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne czynności. Obiekt interfejsu może mieć 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 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

Nazwa	Typ	Opis
`action`	`Action`	Obiekt określający działanie polegające na otwarciu linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

DecoratedText – ten obiekt do łańcucha.

`setOpenLink(openLink)`

Ustawia adres URL, który zostanie otwarty po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i trzeba go tylko otworzyć. Obiekt interfejsu może mieć tylko jeden z tych parametrów: 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 łańcucha.

`setStartIcon(startIcon)`

Ustawia opcjonalny element IconImage do wyświetlania przed treścią tekstową.

Parametry

Nazwa	Typ	Opis
`startIcon`	`IconImage`	Ikona do wyświetlenia.

Powrót

DecoratedText – ten obiekt do łańcucha.

`setSwitchControl(switchToSet)`

Ustawia Switch, który jest wyświetlany po prawej stronie treści. DecoratedTextmoż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 łańcucha.

`setText(text)`

Określa 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 łańcucha.

`setTopLabel(text)`

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

Parametry

Nazwa	Typ	Opis
`text`	`String`	Tekst etykiety.

Powrót

DecoratedText – ten obiekt do łańcucha.

`setWrapText(wrapText)`

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

Parametry

Nazwa	Typ	Opis
`wrapText`	`Boolean`	Jeśli `true`, tekst jest przenoszony i wyświetlany na kilku wierszach. W przeciwnym razie tekst jest obcinany.

Powrót

DecoratedText – ten obiekt do łańcucha.