Class DecoratedText

DecoratedText

Widget yang menampilkan teks dengan dekorasi opsional. Kemungkinan kunci mencakup ikon, label di atas, dan label di bawah. Menetapkan 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.

Tersedia untuk add-on Google Workspace dan aplikasi Google Chat.

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addEventAction(eventAction)WidgetMenambahkan tindakan peristiwa yang dapat dilakukan pada widget.
setAuthorizationAction(action)DecoratedTextMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setBottomLabel(text)DecoratedTextMenetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di bawah konten teks.
setButton(button)DecoratedTextMenetapkan Button yang ditampilkan di sebelah kanan teks.
setComposeAction(action, composedEmailType)DecoratedTextMenetapkan tindakan yang menyusun email draf saat objek diklik.
setEndIcon(endIcon)DecoratedTextMenetapkan IconImage opsional yang ditampilkan di sebelah kanan konten.
setId(id)WidgetMenetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah.
setOnClickAction(action)DecoratedTextMenetapkan tindakan yang dijalankan saat objek diklik.
setOnClickOpenLinkAction(action)DecoratedTextMenetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)DecoratedTextMenetapkan URL yang akan dibuka saat objek diklik.
setStartIcon(startIcon)DecoratedTextMenetapkan IconImage opsional untuk ditampilkan sebelum konten teks.
setSwitchControl(switchToSet)DecoratedTextMenetapkan Switch yang ditampilkan di sebelah kanan konten.
setText(text)DecoratedTextMenetapkan teks yang akan digunakan sebagai nilai.
setTopLabel(text)DecoratedTextMenetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di atas konten teks.
setVisibility(visibility)WidgetMenetapkan visibilitas widget.
setWrapText(wrapText)DecoratedTextMenetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris.

Dokumentasi mendetail

addEventAction(eventAction)

Menambahkan tindakan peristiwa yang dapat dilakukan pada widget.

Parameter

NamaJenisDeskripsi
eventActionEventActionEventAction yang akan ditambahkan.

Pulang pergi

Widget — Objek, untuk pengaitan.


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 set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parameter

NamaJenisDeskripsi
actionAuthorizationActionObjek yang menentukan tindakan otorisasi yang akan diambil saat elemen ini diklik.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setBottomLabel(text)

Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di bawah konten teks.

Parameter

NamaJenisDeskripsi
textStringTeks label.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setButton(button)

Menetapkan Button yang ditampilkan di sebelah kanan teks. DecoratedText hanya dapat mendukung satu tombol atau satu sakelar.

Parameter

NamaJenisDeskripsi
buttonButtonTombol untuk menambahkan.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setComposeAction(action, composedEmailType)

Menetapkan tindakan yang menyusun email draf saat objek diklik. Objek UI hanya dapat memiliki satu setelan setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

Parameter Action harus menentukan fungsi callback yang menampilkan objek ComposeActionResponse yang dikonfigurasi menggunakan ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parameter

NamaJenisDeskripsi
actionActionObjek yang menentukan tindakan compose yang akan diambil saat elemen ini diklik.
composedEmailTypeComposedEmailTypeNilai enum yang menentukan apakah draf yang disusun adalah draf mandiri atau draf balasan.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setEndIcon(endIcon)

Menetapkan IconImage opsional yang ditampilkan di sebelah kanan konten. DecoratedText hanya dapat mendukung satu tombol, satu tombol geser, atau satu ikon.

Parameter

NamaJenisDeskripsi
endIconIconImageIkon yang akan ditambahkan.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setId(id)

Menetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah. Mutasi widget hanya didukung di Add-On.

Parameter

NamaJenisDeskripsi
idStringID widget, dengan batas 64 karakter dan dalam format `[a-zA-Z0-9-]+`.

Pulang pergi

Widget — Objek ini, untuk pengaitan.


setOnClickAction(action)

Menetapkan tindakan yang dijalankan saat objek diklik. Objek UI hanya dapat memiliki satu set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

Parameter Action harus menentukan fungsi callback yang menampilkan objek ActionResponse.

// ...

const 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

NamaJenisDeskripsi
actionActionTindakan yang harus diambil saat elemen ini diklik.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setOnClickOpenLinkAction(action)

Menetapkan tindakan yang membuka URL di tab saat objek diklik. Gunakan fungsi ini saat URL perlu dibuat atau saat Anda perlu melakukan tindakan lain selain membuat objek OpenLink. Objek UI hanya dapat memiliki satu set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

Parameter Action harus menentukan fungsi callback yang menampilkan objek ActionResponse yang dikonfigurasi menggunakan ActionResponseBuilder.setOpenLink(openLink).

// ...

const 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

NamaJenisDeskripsi
actionActionObjek yang menentukan tindakan buka link yang akan diambil saat elemen ini diklik.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


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 set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

Parameter

NamaJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang menjelaskan URL yang akan dibuka.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setStartIcon(startIcon)

Menetapkan IconImage opsional untuk ditampilkan sebelum konten teks.

Parameter

NamaJenisDeskripsi
startIconIconImageIkon yang akan ditampilkan.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setSwitchControl(switchToSet)

Menetapkan Switch yang ditampilkan di sebelah kanan konten. DecoratedText hanya dapat mendukung satu tombol atau satu sakelar.

Parameter

NamaJenisDeskripsi
switchToSetSwitchTombol yang akan ditambahkan.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setText(text)

Menetapkan teks yang akan digunakan sebagai nilai. Mendukung pemformatan HTML dasar. Wajib.

Parameter

NamaJenisDeskripsi
textStringKonten teks untuk widget ini.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setTopLabel(text)

Menetapkan teks label yang akan digunakan sebagai kunci dan ditampilkan di atas konten teks.

Parameter

NamaJenisDeskripsi
textStringTeks label.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.


setVisibility(visibility)

Menetapkan visibilitas widget. Nilai defaultnya adalah `VISIBLE`.

Parameter

NamaJenisDeskripsi
visibilityVisibilityVisibility widget.

Pulang pergi

Widget — Objek, untuk pengaitan.


setWrapText(wrapText)

Menetapkan apakah teks nilai harus ditampilkan dalam satu baris atau beberapa baris.

Parameter

NamaJenisDeskripsi
wrapTextBooleanJika true, teks akan di-wrap dan ditampilkan dalam beberapa baris. Jika tidak, teks akan terpotong.

Pulang pergi

DecoratedText — Objek ini, untuk pengaitan.