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 set i jednego z tych znaków: Decorated, Decorated, set lub set. Te zajęcia mają zastąpić .
Key
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
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
add | Widget | Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie. |
set | Decorated | Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu. |
set | Decorated | Ustawia tekst etykiety, który będzie używany jako klucz i wyświetlany pod treścią tekstową. |
set | Decorated | Ustawia Button wyświetlany po prawej stronie tekstu. |
set | Decorated | Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. |
set | Decorated | Ustawia opcjonalny element Icon, który jest wyświetlany po prawej stronie treści. |
set | Widget | Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. |
set | Decorated | Ustawia działanie, które jest wykonywane po kliknięciu obiektu. |
set | Decorated | Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu. |
set | Decorated | Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu. |
set | Decorated | Ustawia opcjonalny znak Icon, który ma być wyświetlany przed treścią tekstową. |
set | Decorated | Określa Switch wyświetlany po prawej stronie treści. |
set | Decorated | Ustawia tekst, który ma być używany jako wartość. |
set | Decorated | Ustawia tekst etykiety, który będzie używany jako klucz i jest wyświetlany nad treścią tekstową. |
set | Widget | Ustawia widoczność widżetu. |
set | Decorated | Określa, czy tekst wartości ma być wyświetlany w jednym czy w wielu wierszach. |
Szczegółowa dokumentacja
add Event Action(eventAction)
Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
event | Event | Event do dodania. |
Powrót
Widget – obiekt do łączenia.
set Authorization Action(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: set, set, set, set lub set.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
action | Authorization | Obiekt określający działanie autoryzacji, które ma zostać wykonane po kliknięciu tego elementu. |
Powrót
Decorated – ten obiekt do łączenia.
set Bottom Label(text)
Ustawia tekst etykiety, który będzie używany jako klucz i wyświetlany pod treścią tekstową.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
text | String | Tekst etykiety. |
Powrót
Decorated – ten obiekt do łączenia.
set Button(button)
Ustawia Button wyświetlany po prawej stronie tekstu. Decorated może obsługiwać tylko 1 przycisk lub 1 przełącznik.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
button | Button | Przycisk dodawania. |
Powrót
Decorated – ten obiekt do łączenia.
set Compose Action(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: set, set, set, set lub set.
Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt Compose skonfigurowany za pomocą Compose.
// ... 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 tworzenia, które ma zostać wykonane po kliknięciu tego elementu. |
composed | Composed | Wartość wyliczeniowa określająca, czy utworzony projekt jest projektem samodzielnym czy projektem odpowiedzi. |
Powrót
Decorated – ten obiekt do łączenia.
set End Icon(endIcon)
Ustawia opcjonalny element Icon, który jest wyświetlany po prawej stronie treści. Decorated może obsługiwać tylko 1 przycisk, 1 przełącznik lub 1 ikonę.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
end | Icon | Ikona do dodania. |
Powrót
Decorated – ten obiekt do łączenia.
set Id(id)
Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. Modyfikacja widżetu jest obsługiwana tylko w dodatkach.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
id | String | Identyfikator 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.
set On Click Action(action)
Ustawia działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: set, set, set, set lub set.
Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt Action.
// ... 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 należy wykonać po kliknięciu tego elementu. |
Powrót
Decorated – ten obiekt do łączenia.
set On Click Open Link Action(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 Open musisz wykonać inne działania. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: set, set, set, set lub set.
Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt Action skonfigurowany za pomocą Action.
// ... 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
Decorated – ten obiekt do łączenia.
set Open Link(openLink)
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: set, set, set, set lub set.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
open | Open | Obiekt Open opisujący adres URL do otwarcia. |
Powrót
Decorated – ten obiekt do łączenia.
set Start Icon(startIcon)
Ustawia opcjonalny znak Icon, który ma być wyświetlany przed treścią tekstową.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
start | Icon | Ikona do wyświetlenia. |
Powrót
Decorated – ten obiekt do łączenia.
set Switch Control(switchToSet)
Określa Switch wyświetlany po prawej stronie treści. Decorated
może obsługiwać tylko 1 przycisk lub 1 przełącznik.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
switch | Switch | Przełącznik do dodania. |
Powrót
Decorated – ten obiekt do łączenia.
set Text(text)
Ustawia tekst, który ma być używany jako wartość. Obsługuje podstawowe formatowanie HTML. Wymagane.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
text | String | Zawartość tekstowa tego widżetu. |
Powrót
Decorated – ten obiekt do łączenia.
set Top Label(text)
Ustawia tekst etykiety, który będzie używany jako klucz i jest wyświetlany nad treścią tekstową.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
text | String | Tekst etykiety. |
Powrót
Decorated – ten obiekt do łączenia.
set Visibility(visibility)
Ustawia widoczność widżetu. Wartością domyślną jest „VISIBLE”.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
visibility | Visibility | Visibility widżetu. |
Powrót
Widget – obiekt do łączenia.
set Wrap Text(wrapText)
Określa, czy tekst wartości ma być wyświetlany w jednym czy w wielu wierszach.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
wrap | Boolean | Jeśli true, tekst jest zawijany i wyświetlany w wielu wierszach. W przeciwnym razie tekst zostanie obcięty. |
Powrót
Decorated – ten obiekt do łączenia.