TextButton
z etykietą tekstową. W razie potrzeby możesz ustawić kolor tła i dezaktywować przycisk.
Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.
const textButton = CardService.newTextButton() .setText('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
setAltText(altText) | TextButton | Ustawia tekst zastępczy przycisku na potrzeby ułatwień dostępu. |
setAuthorizationAction(action) | TextButton | Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu. |
setBackgroundColor(backgroundColor) | TextButton | Ustawia kolor tła przycisku TextButtonStyle.FILLED . |
setComposeAction(action, composedEmailType) | TextButton | Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila. |
setDisabled(disabled) | TextButton | Określa, czy przycisk jest wyłączony. |
setIcon(icon) | TextButton | Ustawia wstępnie zdefiniowany Icon do wyświetlania na przycisku. |
setIconUrl(url) | TextButton | Ustawia adres URL obrazu, który ma być używany jako ikona tego przycisku. |
setMaterialIcon(icon) | TextButton | Umożliwia skonfigurowanie ikony w ramach projektu Material Design. |
setOnClickAction(action) | TextButton | Określa działanie, które jest wykonywane po kliknięciu obiektu. |
setOnClickOpenLinkAction(action) | TextButton | Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu. |
setOpenLink(openLink) | TextButton | Ustawia adres URL otwierany po kliknięciu obiektu. |
setOverflowMenu(menu) | TextButton | Ustawia menu, które otwiera się po kliknięciu obiektu. |
setText(text) | TextButton | Ustawia tekst, który ma być wyświetlany na przycisku. |
setTextButtonStyle(textButtonStyle) | TextButton | Ustawia styl przycisku. |
Szczegółowa dokumentacja
setAltText(altText)
Ustawia tekst zastępczy przycisku na potrzeby ułatwień dostępu. Jeśli nie jest ustawiony, domyślnie jest używany tekst wyświetlany na przycisku.
Parametry
Nazwa | Typ | Opis |
---|---|---|
altText | String | Tekst zastępczy do przypisania do tego przycisku. |
Powrót
TextButton
– ten obiekt do łańcucha.
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
TextButton
– ten obiekt do łańcucha.
setBackgroundColor(backgroundColor)
Ustawia kolor tła przycisku TextButtonStyle.FILLED
. Jeśli nie ustawisz koloru dodatkowego dla przycisku TextButtonStyle.FILLED
, zostanie użyty kolor dodatkowy zdefiniowany w manifest dodatku.
Ta metoda nie działa w przypadku przycisków TextButtonStyle.OUTLINED
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
backgroundColor | String | Kolor w formacie #rgb. |
Powrót
TextButton
– 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
TextButton
– ten obiekt do łańcucha.
setDisabled(disabled)
Określa, czy przycisk ma być wyłączony. Wyłączony przycisk jest wyszarzony i nie można go kliknąć.
Parametry
Nazwa | Typ | Opis |
---|---|---|
disabled | Boolean | Stan wyłączony. |
Powrót
TextButton
– ten obiekt do łańcucha.
setIcon(icon)
Ustawia wstępnie zdefiniowany Icon
do wyświetlania na przycisku. Do zdefiniowania obrazu przycisku należy użyć tej albo wartości setIconUrl(url)
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
icon | Icon | jedną z wstępnie zdefiniowanych wartości Icon . |
Powrót
TextButton
– ten obiekt do łańcucha.
setIconUrl(url)
Ustawia adres URL obrazu, który ma być używany jako ikona tego przycisku. Aby zdefiniować obraz przycisku, musisz użyć tej właściwości lub właściwości setIcon(icon)
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
url | String | Adres URL hostowanego obrazu, który ma być używany jako ikona tego przycisku. |
Powrót
TextButton
– ten obiekt do łańcucha.
setMaterialIcon(icon)
Umożliwia skonfigurowanie ikony w ramach projektu Material Design.
const textButton = CardService.newTextButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
Parametry
Nazwa | Typ | Opis |
---|---|---|
icon | MaterialIcon | Ikona Material Design. |
Powrót
TextButton
– obiekt do tworzenia łańcuchów.
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, jakie ma zostać wykonane po kliknięciu tego elementu. |
Powrót
TextButton
– 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 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
TextButton
– ten obiekt do łańcucha.
setOpenLink(openLink)
Ustawia adres URL otwierany 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, który ma zostać otwarty. |
Powrót
TextButton
– obiekt do tworzenia łańcuchów.
setOverflowMenu(menu)
Ustawia menu, które otwiera się po kliknięciu obiektu. Każdy element w menu może określać działanie, które zostanie wykonane po kliknięciu. Zagnieżdżone menu nie są obsługiwane, a czynności dotyczące pozycji menu nie powinny określać menu przepełnienia.
Dostępne tylko w aplikacjach Google Chat. Niedostępne w przypadku dodatków Google Workspace.
const overflowMenuItem = CardService.newOverflowMenuItem() .setStartIcon( CardService.newIconImage().setIconUrl( 'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png', ), ) .setText('Open Link') .setOpenLink( CardService.newOpenLink().setUrl('https://www.google.com')); const overflowMenu = CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();
Parametry
Nazwa | Typ | Opis |
---|---|---|
menu | OverflowMenu | Obiekt określający menu rozszerzone, które ma się wyświetlić po kliknięciu tego elementu. |
Powrót
TextButton
– ten obiekt do łańcucha.
setText(text)
Określa tekst wyświetlany na przycisku.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Tekst widoczny na przycisku. |
Powrót
TextButton
– obiekt do tworzenia łańcuchów.
setTextButtonStyle(textButtonStyle)
Ustawia styl przycisku. Jeśli nie jest ustawiony, domyślnie jest używany przycisk TextButtonStyle.OUTLINED
.
const button = CardService.newTextButton() .setText('Filled') .setTextButtonStyle(CardService.TextButtonStyle.FILLED) .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));
Parametry
Nazwa | Typ | Opis |
---|---|---|
textButtonStyle | TextButtonStyle | Styl przycisku. |
Powrót
TextButton
– ten obiekt do łańcucha.