Widget yang menampilkan teks dengan dekorasi opsional. Kunci yang mungkin menyertakan ikon dan label
di atas dan label di bawah. Konten teks dan salah satu kunci diperlukan untuk menyetel konten teks dan salah satu kunci menggunakan setText(text)
serta salah satu dari DecoratedText
, DecoratedText
, setTopLabel(text)
, atau setBottomLabel(text)
. Class ini dimaksudkan untuk menggantikan
.
KeyValue
Tersedia untuk Add-on Google Workspace dan aplikasi Google Chat.
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 membuat email draf 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 | Menyetel 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. Ketika pengguna menyelesaikan alur otorisasi dan kembali ke aplikasi, add-on akan dimuat ulang.
Objek UI hanya dapat memiliki salah 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
Nama | Jenis | Deskripsi |
---|---|---|
action | AuthorizationAction | Objek yang menentukan tindakan otorisasi yang akan diambil ketika elemen ini diklik. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setBottomLabel(text)
Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di bawah konten teks.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
text | String | Teks label. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setButton(button)
Menetapkan Button
yang ditampilkan di sebelah kanan teks. Sebuah DecoratedText
dapat
hanya mendukung satu tombol atau satu tombol.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
button | Button | Tombol untuk menambahkan. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setComposeAction(action, composedEmailType)
Menetapkan tindakan yang membuat email draf saat objek diklik. Objek UI hanya dapat
memiliki salah satu dari setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
, atau setComposeAction(action, composedEmailType)
disetel.
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
Nama | Jenis | Deskripsi |
---|---|---|
action | Action | Objek yang menentukan tindakan compose yang akan diambil saat elemen ini diklik. |
composedEmailType | ComposedEmailType | Nilai enum yang menentukan apakah draf yang ditulis merupakan draf mandiri atau balasan. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setEndIcon(endIcon)
Menetapkan IconImage
opsional yang ditampilkan di sebelah kanan konten. DecoratedText
hanya dapat mendukung satu tombol, satu tombol, atau satu ikon.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
endIcon | IconImage | Ikon yang akan ditambahkan. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setOnClickAction(action)
Menetapkan tindakan yang dijalankan saat objek diklik. Objek UI hanya
dapat memiliki salah satu
setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
, atau setComposeAction(action, composedEmailType)
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
Nama | Jenis | Deskripsi |
---|---|---|
action | Action | Tindakan yang akan dilakukan saat elemen ini diklik. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
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 sebagai tambahan untuk membuat objek OpenLink
. Objek UI hanya dapat memiliki salah satu dari setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
, atau
setComposeAction(action, composedEmailType)
disetel.
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
Nama | Jenis | Deskripsi |
---|---|---|
action | Action | Objek yang menetapkan tindakan link terbuka yang akan diambil saat elemen ini diklik. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
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
salah satu dari setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
,
atau setComposeAction(action, composedEmailType)
ditetapkan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
openLink | OpenLink | Objek OpenLink yang menjelaskan URL yang akan dibuka. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setStartIcon(startIcon)
Menyetel IconImage
opsional untuk ditampilkan sebelum konten teks.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
startIcon | IconImage | Ikon yang akan ditampilkan. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setSwitchControl(switchToSet)
Menetapkan Switch
yang ditampilkan di sebelah kanan konten. DecoratedText
hanya dapat mendukung
satu tombol atau satu {i>switch<i}.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
switchToSet | Switch | Tombol yang akan ditambahkan. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setText(text)
Menetapkan teks yang akan digunakan sebagai nilai. Mendukung pemformatan HTML dasar. Wajib.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
text | String | Konten teks untuk widget ini. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setTopLabel(text)
Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di atas konten teks.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
text | String | Teks label. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.
setWrapText(wrapText)
Menetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
wrapText | Boolean | Jika true , teks akan digabungkan dan ditampilkan di beberapa baris. Sebaliknya
teks terpotong. |
Pulang pergi
DecoratedText
— Objek ini, untuk perantaian.