Class DecoratedText

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.
Teks Hias

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

MetodeJenis hasil yang ditampilkanDeskripsi singkat
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 menulis draf email saat objek diklik.
setEndIcon(endIcon)DecoratedTextMenetapkan IconImage opsional yang ditampilkan di sebelah kanan konten.
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.
setWrapText(wrapText)DecoratedTextMenetapkan 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

NameJenisDeskripsi
actionAuthorizationActionObjek 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

NameJenisDeskripsi
textStringTeks 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

NameJenisDeskripsi
buttonButtonTombol 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

NameJenisDeskripsi
actionActionObjek yang menentukan tindakan tulis yang akan diambil saat elemen ini diklik.
composedEmailTypeComposedEmailTypeNilai 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

NameJenisDeskripsi
endIconIconImageIkon 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

NameJenisDeskripsi
actionActionTindakan 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

NameJenisDeskripsi
actionActionObjek yang menentukan tindakan link terbuka yang akan diambil saat elemen ini diklik.

Return

DecoratedText — Objek ini, untuk rantai.


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

NameJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang menjelaskan URL yang akan dibuka.

Return

DecoratedText — Objek ini, untuk rantai.


setStartIcon(startIcon)

Menetapkan IconImage opsional untuk ditampilkan sebelum konten teks.

Parameter

NameJenisDeskripsi
startIconIconImageIkon 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

NameJenisDeskripsi
switchToSetSwitchTombol untuk ditambahkan.

Return

DecoratedText — Objek ini, untuk rantai.


setText(text)

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

Parameter

NameJenisDeskripsi
textStringKonten 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

NameJenisDeskripsi
textStringTeks label.

Return

DecoratedText — Objek ini, untuk rantai.


setWrapText(wrapText)

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

Parameter

NameJenisDeskripsi
wrapTextBooleanJika true, teks akan digabungkan dan ditampilkan di beberapa baris. Jika tidak, teks akan terpotong.

Return

DecoratedText — Objek ini, untuk rantai.