Element ImageButton
z wyświetlonym obrazem.
Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.
var imageButton = CardService.newImageButton() .setAltText("An image button with an airplane icon.") .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink() .setUrl("https://airplane.com"));
Metody
Metoda | Typ zwracanej wartości | Krótki opis |
---|---|---|
setAltText(altText) | ImageButton | Ustawia tekst alternatywny przycisku ułatwień dostępu. |
setAuthorizationAction(action) | ImageButton | Ustawia działanie autoryzacji, które po kliknięciu obiektu otwiera adres URL w procesie autoryzacji. |
setComposeAction(action, composedEmailType) | ImageButton | Ustawia działanie tworzące wersję roboczą e-maila po kliknięciu obiektu. |
setIcon(icon) | ImageButton | Ustawia wstępnie zdefiniowany element Icon wyświetlany na przycisku. |
setIconUrl(url) | ImageButton | Ustawia adres URL obrazu, który ma być używany jako ikona tego przycisku. |
setOnClickAction(action) | ImageButton | Ustawia działanie wykonywane po kliknięciu obiektu. |
setOnClickOpenLinkAction(action) | ImageButton | Ustawia działanie, które otwiera adres URL na karcie po kliknięciu obiektu. |
setOpenLink(openLink) | ImageButton | Ustawia adres URL, który otwiera się po kliknięciu obiektu. |
Szczegółowa dokumentacja
setAltText(altText)
Ustawia tekst alternatywny przycisku ułatwień dostępu. To pole jest wymagane.
Parametry
Nazwa | Typ | Opis |
---|---|---|
altText | String | Tekst alternatywny do przypisania do tego przycisku. |
Powroty
ImageButton
– 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
ImageButton
– 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
ImageButton
– ten obiekt do tworzenia łańcuchów.
setIcon(icon)
Ustawia wstępnie zdefiniowany element Icon
wyświetlany na przycisku. Do zdefiniowania obrazu przycisku należy użyć tego lub parametru setIconUrl(url)
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
icon | Icon | Jedna ze wstępnie zdefiniowanych wartości Icon . |
Powroty
ImageButton
– ten obiekt do tworzenia łańcuchów.
setIconUrl(url)
Ustawia adres URL obrazu, który ma być używany jako ikona tego przycisku. Do zdefiniowania obrazu przycisku należy użyć tego lub obiektu setIcon(icon)
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
url | String | Adres URL hostowanego obrazu, który ma być używany jako ikona tego przycisku. |
Powroty
ImageButton
– 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
ImageButton
– 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
ImageButton
– 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
ImageButton
– ten obiekt do tworzenia łańcuchów.