Widżet wyświetlający tekst z opcjonalnymi ozdobnikami. Możliwe klucze to ikona, etykieta powyżej i etykieta 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.
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 | Określa tekst etykiety, który będzie używany jako klucz i będzie wyświetlany pod treścią tekstową. |
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 | Określa 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 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 się wyświetlać w jednym czy w wielu 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 powró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)
Określa tekst etykiety, który będzie używany jako klucz i będzie wyświetlany pod treścią tekstową.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Tekst etykiety. |
Powrót
DecoratedText
– ten obiekt do łańcucha.
setButton(button)
Ustawia element Button
wyświetlany z prawej strony 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)
.
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { 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)
Ustawia działanie 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 po kliknięciu obiektu otwiera adres URL na karcie. Używaj tej funkcji, gdy musisz utworzyć adres URL lub gdy oprócz utworzenia obiektu OpenLink
musisz wykonać inne działania. Obiekt interfejsu może mieć 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
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 ł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 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 ł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. 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
– 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
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
– 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
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
– obiekt do tworzenia łańcuchów.