Class DecoratedText

DecoratedText

Widget yang menampilkan teks dengan dekorasi opsional. Kunci yang dapat digunakan meliputi ikon, label di atas, dan label di bawah. Anda harus menyetel konten teks dan salah satu kunci menggunakan setText(text) dan salah satu dari DecoratedText, DecoratedText, setTopLabel(text), atau setBottomLabel(text). Class ini ditujukan 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

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAuthorizationAction(action)DecoratedTextMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setBottomLabel(text)DecoratedTextMenyetel 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 membuat 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 akan membuka URL di tab saat objek diklik.
setOpenLink(openLink)DecoratedTextMenetapkan URL yang akan dibuka saat objek diklik.
setStartIcon(startIcon)DecoratedTextMenetapkan IconImage opsional yang akan 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)DecoratedTextMenyetel 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 salah satu dari setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

// ...

var 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.

Return

DecoratedText — Objek ini, untuk perantaian.


setBottomLabel(text)

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

Parameter

NamaJenisDeskripsi
textStringTeks label.

Return

DecoratedText — Objek ini, untuk perantaian.


setButton(button)

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

Parameter

NamaJenisDeskripsi
buttonButtonTombol untuk menambahkan.

Return

DecoratedText — Objek ini, untuk perantaian.


setComposeAction(action, composedEmailType)

Menetapkan tindakan yang membuat draf email saat objek diklik. Objek UI hanya dapat memiliki salah satu dari 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).

// ...

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

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

Return

DecoratedText — Objek ini, untuk perantaian.


setEndIcon(endIcon)

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

Parameter

NamaJenisDeskripsi
endIconIconImageIkon yang akan ditambahkan.

Return

DecoratedText — Objek ini, untuk perantaian.


setOnClickAction(action)

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

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

NamaJenisDeskripsi
actionActionTindakan yang akan diambil saat elemen ini diklik.

Return

DecoratedText — Objek ini, untuk perantaian.


setOnClickOpenLinkAction(action)

Menetapkan tindakan yang akan membuka URL di tab saat objek diklik. Gunakan fungsi ini saat URL perlu dibuat atau saat Anda perlu mengambil tindakan lain selain untuk membuat objek OpenLink. Objek UI hanya dapat memiliki salah satu dari 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).

// ...

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

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

Return

DecoratedText — Objek ini, untuk perantaian.


Menetapkan URL yang akan dibuka saat objek diklik. Gunakan fungsi ini jika 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).

Parameter

NamaJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang mendeskripsikan URL yang akan dibuka.

Return

DecoratedText — Objek ini, untuk perantaian.


setStartIcon(startIcon)

Menetapkan IconImage opsional yang akan ditampilkan sebelum konten teks.

Parameter

NamaJenisDeskripsi
startIconIconImageIkon yang akan ditampilkan.

Return

DecoratedText — Objek ini, untuk perantaian.


setSwitchControl(switchToSet)

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

Parameter

NamaJenisDeskripsi
switchToSetSwitchTombol untuk menambahkan.

Return

DecoratedText — Objek ini, untuk perantaian.


setText(text)

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

Parameter

NamaJenisDeskripsi
textStringKonten teks untuk widget ini.

Return

DecoratedText — Objek ini, untuk perantaian.


setTopLabel(text)

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

Parameter

NamaJenisDeskripsi
textStringTeks label.

Return

DecoratedText — Objek ini, untuk perantaian.


setWrapText(wrapText)

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

Parameter

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

Return

DecoratedText — Objek ini, untuk perantaian.