Widget yang menampilkan teks dengan dekorasi opsional. Kemungkinan kunci meliputi ikon, label di atas, dan label di bawah. Menyetel konten teks dan salah satu kunci diperlukan menggunakan setText(text)
dan salah satu dari DecoratedText
, DecoratedText
, setTopLabel(text)
, atau setBottomLabel(text)
. Class ini dimaksudkan untuk menggantikan
.
KeyValue
var decoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel"); var multilineDecoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel") .setWrapText(true) .setBottomLabel("BottomLabel");
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik. |
setBottomLabel(text) | DecoratedText | Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di bawah konten teks. |
setButton(button) | DecoratedText | Menetapkan Button yang ditampilkan di sebelah kanan teks. |
setComposeAction(action, composedEmailType) | DecoratedText | Menetapkan tindakan yang menulis draf email saat objek diklik. |
setEndIcon(endIcon) | DecoratedText | Menetapkan IconImage opsional yang ditampilkan di sebelah kanan konten. |
setOnClickAction(action) | DecoratedText | Menetapkan tindakan yang dijalankan saat objek diklik. |
setOnClickOpenLinkAction(action) | DecoratedText | Menetapkan tindakan yang membuka URL di tab saat objek diklik. |
setOpenLink(openLink) | DecoratedText | Menetapkan URL yang akan dibuka saat objek diklik. |
setStartIcon(startIcon) | DecoratedText | Menetapkan IconImage opsional untuk ditampilkan sebelum konten teks. |
setSwitchControl(switchToSet) | DecoratedText | Menetapkan Switch yang ditampilkan di sebelah kanan konten. |
setText(text) | DecoratedText | Menetapkan teks yang akan digunakan sebagai nilai. |
setTopLabel(text) | DecoratedText | Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di atas konten teks. |
setWrapText(wrapText) | DecoratedText | Menetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris. |
Dokumentasi mendetail
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
DecoratedText
— Objek ini, untuk rantai.
setBottomLabel(text)
Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di bawah konten teks.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
text | String | Teks label. |
Return
DecoratedText
— Objek ini, untuk rantai.
setButton(button)
Menetapkan Button
yang ditampilkan di sebelah kanan teks. DecoratedText
hanya
dapat mendukung satu tombol atau satu tombol.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
button | Button | Tombol untuk menambahkan. |
Return
DecoratedText
— 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
DecoratedText
— Objek ini, untuk rantai.
setEndIcon(endIcon)
Menetapkan IconImage
opsional yang ditampilkan di sebelah kanan konten. DecoratedText
hanya dapat mendukung satu tombol, satu tombol, atau satu ikon.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
endIcon | IconImage | Ikon yang akan ditambahkan. |
Return
DecoratedText
— 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
DecoratedText
— 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
DecoratedText
— 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
DecoratedText
— Objek ini, untuk rantai.
setStartIcon(startIcon)
Menetapkan IconImage
opsional untuk ditampilkan sebelum konten teks.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
startIcon | IconImage | Ikon yang akan ditampilkan. |
Return
DecoratedText
— Objek ini, untuk rantai.
setSwitchControl(switchToSet)
Menetapkan Switch
yang ditampilkan di sebelah kanan konten. DecoratedText
hanya dapat mendukung satu tombol atau satu tombol.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
switchToSet | Switch | Tombol untuk ditambahkan. |
Return
DecoratedText
— Objek ini, untuk rantai.
setText(text)
Menetapkan teks yang akan digunakan sebagai nilai. Mendukung format HTML dasar. Wajib diisi.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
text | String | Konten teks untuk widget ini. |
Return
DecoratedText
— Objek ini, untuk rantai.
setTopLabel(text)
Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di atas konten teks.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
text | String | Teks label. |
Return
DecoratedText
— Objek ini, untuk rantai.
setWrapText(wrapText)
Menetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris.
Parameter
Name | Jenis | Deskripsi |
---|---|---|
wrapText | Boolean | Jika true , teks akan digabungkan dan ditampilkan di beberapa baris. Jika tidak, teks akan terpotong. |
Return
DecoratedText
— Objek ini, untuk rantai.