Element typu TextButton
z etykietą tekstową. Możesz ustawić kolor tła i w razie potrzeby
zdezaktywować przycisk.
Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.
var textButton = CardService.newTextButton() .setText("Open Link") .setOpenLink(CardService.newOpenLink() .setUrl("https://www.google.com"));
Metody
Metoda | Typ zwracanej wartości | Krótki opis |
---|---|---|
setAltText(altText) | TextButton | Ustawia tekst alternatywny przycisku ułatwień dostępu. |
setAuthorizationAction(action) | TextButton | Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL w procesie autoryzacji. |
setBackgroundColor(backgroundColor) | TextButton | Ustawia kolor tła przycisku TextButtonStyle.FILLED . |
setComposeAction(action, composedEmailType) | TextButton | Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu. |
setDisabled(disabled) | TextButton | Określa, czy przycisk ma być wyłączony. |
setOnClickAction(action) | TextButton | Ustawia działanie wykonywane po kliknięciu obiektu. |
setOnClickOpenLinkAction(action) | TextButton | Ustawia działanie, które otwiera adres URL na karcie po kliknięciu obiektu. |
setOpenLink(openLink) | TextButton | Ustawia adres URL, który otwiera się po kliknięciu obiektu. |
setText(text) | TextButton | Ustawia tekst wyświetlany na przycisku. |
setTextButtonStyle(textButtonStyle) | TextButton | Ustawia styl przycisku. |
Szczegółowa dokumentacja
setAltText(altText)
Ustawia tekst alternatywny przycisku ułatwień dostępu. Jeśli zasada jest nieskonfigurowana, domyślnie przyjmuje się tekst wyświetlany na przycisku.
Parametry
Nazwa | Typ | Opis |
---|---|---|
altText | String | Tekst alternatywny do przypisania do tego przycisku. |
Powroty
TextButton
– ten obiekt do tworzenia łańcuchów.
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
TextButton
– ten obiekt do tworzenia łańcuchów.
setBackgroundColor(backgroundColor)
Ustawia kolor tła przycisku TextButtonStyle.FILLED
. Jeśli przycisk TextButtonStyle.FILLED
nie jest skonfigurowany, będzie używany kolor dodatkowy określony w pliku manifestu dodatku.
W przypadku przycisków TextButtonStyle.OUTLINED
ta metoda nie jest obsługiwana.
Parametry
Nazwa | Typ | Opis |
---|---|---|
backgroundColor | String | Kolor w formacie #rgb. |
Powroty
TextButton
– 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
TextButton
– ten obiekt do tworzenia łańcuchów.
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. |
Powroty
TextButton
– 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
TextButton
– 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
TextButton
– 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
TextButton
– ten obiekt do tworzenia łańcuchów.
setText(text)
Ustawia tekst wyświetlany na przycisku.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Tekst widoczny na przycisku. |
Powroty
TextButton
– ten obiekt do tworzenia łańcuchów.
setTextButtonStyle(textButtonStyle)
Ustawia styl przycisku. Jeśli zasada nie jest skonfigurowana, domyślnie jest to przycisk TextButtonStyle.OUTLINED
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
textButtonStyle | TextButtonStyle | Styl przycisku. |
Powroty
TextButton
– ten obiekt do tworzenia łańcuchów.