Widżet wyświetlający 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 elementów: DecoratedText
, DecoratedText
, setTopLabel(text)
lub setBottomLabel(text)
. Ta klasa ma zastąpić
.
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
Metoda | Typ zwracanej wartości | Krótki opis |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL w procesie autoryzacji. |
setBottomLabel(text) | DecoratedText | Ustawia tekst etykiety, który będzie używany jako klucz i będzie wyświetlany pod tekstem. |
setButton(button) | DecoratedText | Ustawia Button , który jest wyświetlany po prawej stronie tekstu. |
setComposeAction(action, composedEmailType) | DecoratedText | Ustawia działanie tworzące 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 otwiera adres URL na karcie po kliknięciu obiektu. |
setOpenLink(openLink) | DecoratedText | Ustawia adres URL, który otwiera się po kliknięciu obiektu. |
setStartIcon(startIcon) | DecoratedText | Ustawia opcjonalny element IconImage wyświetlany przed treścią tekstową. |
setSwitchControl(switchToSet) | DecoratedText | Ustawia Switch , który jest wyświetlany po prawej stronie treści. |
setText(text) | DecoratedText | Ustawia tekst, który zostanie użyty jako wartość. |
setTopLabel(text) | DecoratedText | Ustawia tekst etykiety, który będzie używany jako klucz i będzie wyświetlany nad tekstem. |
setWrapText(wrapText) | DecoratedText | Określa, czy tekst wartości ma być wyświetlany w jednym wierszu czy w wielu. |
Szczegółowa dokumentacja
setAuthorizationAction(action)
Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL w procesie autoryzacji. Adres URL zostanie otwarty w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, dodatek załaduje się ponownie.
Obiekt UI może mieć ustawiony tylko jeden z tych elementó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 określający działanie autoryzacji, które ma być wykonywane po kliknięciu tego elementu. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setBottomLabel(text)
Ustawia tekst etykiety, który będzie używany jako klucz i będzie wyświetlany pod tekstem.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Tekst etykiety. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setButton(button)
Ustawia Button
, który jest 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 do dodania. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setComposeAction(action, composedEmailType)
Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu. Obiekt UI może mieć ustawiony tylko jeden z tych elementó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)
.
// ... 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 czynność tworzenia, która ma być wykonywana po kliknięciu tego elementu. |
composedEmailType | ComposedEmailType | Wartość wyliczenia, która określa, czy stworzona wersja robocza jest samodzielną wersją roboczą, czy wersją odpowiedzi. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
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, którą chcesz dodać. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setOnClickAction(action)
Ustawia działanie wykonywane po kliknięciu obiektu. Obiekt UI 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 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, jakie ma być wykonywane po kliknięciu tego elementu. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setOnClickOpenLinkAction(action)
Ustawia działanie, które otwiera adres URL na karcie po kliknięciu obiektu. Użyj tej funkcji, gdy trzeba skompilować adres URL lub gdy trzeba wykonać inne działania oprócz utworzenia obiektu OpenLink
. Obiekt UI może mieć ustawiony tylko jeden z tych elementó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)
.
// ... 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 określający działanie otwierania linku, które ma być wykonywane po kliknięciu tego elementu. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setOpenLink(openLink)
Ustawia adres URL, który otwiera się po kliknięciu obiektu. Tej funkcji należy używać, gdy adres URL jest już znany i tylko trzeba go otworzyć. Obiekt UI może mieć ustawiony tylko jeden z tych elementó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. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setStartIcon(startIcon)
Ustawia opcjonalny element IconImage
wyświetlany przed treścią tekstową.
Parametry
Nazwa | Typ | Opis |
---|---|---|
startIcon | IconImage | Ikona do wyświetlenia. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setSwitchControl(switchToSet)
Ustawia 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, który chcesz dodać. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setText(text)
Ustawia tekst, który zostanie użyty jako wartość. Obsługuje podstawowe formatowanie HTML. To pole jest wymagane.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Zawartość tekstowa tego widżetu. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setTopLabel(text)
Ustawia tekst etykiety, który będzie używany jako klucz i będzie wyświetlany nad tekstem.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Tekst etykiety. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.
setWrapText(wrapText)
Określa, czy tekst wartości ma być wyświetlany w jednym wierszu czy w wielu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
wrapText | Boolean | W przypadku true tekst jest zawijany i wyświetlany w wielu wierszach. W przeciwnym razie tekst jest obcięty. |
Powroty
DecoratedText
– ten obiekt do tworzenia łańcuchów.