ImageButton
dengan gambar yang ditampilkan di atasnya.
var imageButton = CardService.newImageButton() .setAltText("An image button with an airplane icon.") .setIcon(CardService.Icon.AIRPLANE) .setOpenLink(CardService.newOpenLink() .setUrl("https://airplane.com"));
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
setAltText(altText) | ImageButton | Menetapkan teks alternatif tombol untuk aksesibilitas. |
setAuthorizationAction(action) | ImageButton | Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik. |
setComposeAction(action, composedEmailType) | ImageButton | Menetapkan tindakan yang menulis draf email saat objek diklik. |
setIcon(icon) | ImageButton | Menetapkan Icon yang telah ditetapkan untuk ditampilkan pada tombol. |
setIconUrl(url) | ImageButton | Menetapkan URL gambar yang akan digunakan sebagai ikon tombol ini. |
setOnClickAction(action) | ImageButton | Menetapkan tindakan yang dijalankan saat objek diklik. |
setOnClickOpenLinkAction(action) | ImageButton | Menetapkan tindakan yang membuka URL di tab saat objek diklik. |
setOpenLink(openLink) | ImageButton | Menetapkan URL yang akan dibuka saat objek diklik. |
Dokumentasi mendetail
setAltText(altText)
Menetapkan teks alternatif tombol untuk aksesibilitas. Wajib diisi.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
altText | String | Teks alternatif yang akan ditetapkan ke tombol ini. |
Return
ImageButton
— Objek ini, untuk rantai.
setAuthorizationAction(action)
Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik. Tindakan ini akan membuka URL di jendela baru. Saat pengguna menyelesaikan alur otorisasi dan kembali ke aplikasi, add-on akan dimuat ulang.
Objek UI hanya dapat memiliki satu dari setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
, atau setComposeAction(action, composedEmailType)
yang ditetapkan.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameter
Name | Jenis | Deskripsi |
---|---|---|
action | AuthorizationAction | Objek yang menentukan tindakan otorisasi yang harus dilakukan saat elemen ini diklik. |
Return
ImageButton
— Objek ini, untuk rantai.
setComposeAction(action, composedEmailType)
Menetapkan tindakan yang menulis draf email saat objek diklik. Objek UI hanya dapat memiliki
satu dari setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
, atau setComposeAction(action, composedEmailType)
yang ditetapkan.
Parameter Action
harus menentukan fungsi callback yang menampilkan objek ComposeActionResponse
yang dikonfigurasi menggunakan 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(); }
Parameter
Name | Jenis | Deskripsi |
---|---|---|
action | Action | Objek yang menentukan tindakan tulis yang akan diambil saat elemen ini diklik. |
composedEmailType | ComposedEmailType | Nilai enum yang menentukan apakah draf yang disusun adalah draf mandiri atau draf balasan. |
Return
ImageButton
— Objek ini, untuk rantai.
setIcon(icon)
Menetapkan Icon
yang telah ditetapkan untuk ditampilkan pada tombol. Ini atau setIconUrl(url)
harus digunakan untuk menentukan gambar tombol.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
icon | Icon | Salah satu dari nilai Icon yang telah ditetapkan. |
Return
ImageButton
— Objek ini, untuk rantai.
setIconUrl(url)
Menetapkan URL gambar yang akan digunakan sebagai ikon tombol ini. Ini atau setIcon(icon)
harus
digunakan untuk menentukan gambar tombol.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
url | String | Alamat URL gambar yang dihosting untuk digunakan sebagai ikon tombol ini. |
Return
ImageButton
— Objek ini, untuk rantai.
setOnClickAction(action)
Menetapkan tindakan yang dijalankan saat objek diklik. Objek UI hanya dapat memiliki satu dari
setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
, atau setComposeAction(action, composedEmailType)
yang ditetapkan.
Parameter Action
harus menentukan fungsi callback yang menampilkan objek 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(); }
Parameter
Name | Jenis | Deskripsi |
---|---|---|
action | Action | Tindakan yang harus diambil saat elemen ini diklik. |
Return
ImageButton
— Objek ini, untuk rantai.
setOnClickOpenLinkAction(action)
Menetapkan tindakan yang membuka URL di tab saat objek diklik. Gunakan fungsi ini saat
URL harus dibuat atau saat Anda perlu melakukan tindakan lain selain membuat objek OpenLink
. Objek UI hanya dapat memiliki satu dari setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
, atau
setComposeAction(action, composedEmailType)
yang ditetapkan.
Parameter Action
harus menentukan fungsi callback yang menampilkan objek ActionResponse
yang dikonfigurasi menggunakan 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(); }
Parameter
Name | Jenis | Deskripsi |
---|---|---|
action | Action | Objek yang menentukan tindakan link terbuka yang akan diambil saat elemen ini diklik. |
Return
ImageButton
— Objek ini, untuk rantai.
setOpenLink(openLink)
Menetapkan URL yang akan dibuka saat objek diklik. Gunakan fungsi ini saat URL sudah diketahui dan hanya perlu dibuka. Objek UI hanya dapat memiliki satu dari setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
,
atau setComposeAction(action, composedEmailType)
yang ditetapkan.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
openLink | OpenLink | Objek OpenLink yang menjelaskan URL yang akan dibuka. |
Return
ImageButton
— Objek ini, untuk rantai.