Class TextButton

TextButton

TextButton dengan label teks. Anda dapat menetapkan warna latar belakang dan menonaktifkan tombol jika diperlukan.

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
setAltText(altText)	TextButton	Menetapkan teks alternatif tombol untuk aksesibilitas.
setAuthorizationAction(action)	TextButton	Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setBackgroundColor(backgroundColor)	TextButton	Menetapkan warna latar belakang untuk tombol TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)	TextButton	Menetapkan tindakan yang menulis draf email saat objek diklik.
setDisabled(disabled)	TextButton	Menetapkan apakah tombol dinonaktifkan.
setIcon(icon)	TextButton	Menetapkan Icon standar untuk ditampilkan di tombol.
setIconUrl(url)	TextButton	Menetapkan URL gambar yang akan digunakan sebagai ikon tombol ini.
setMaterialIcon(icon)	TextButton	Menetapkan ikon desain material.
setOnClickAction(action)	TextButton	Menetapkan tindakan yang dieksekusi saat objek diklik.
setOnClickOpenLinkAction(action)	TextButton	Menetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)	TextButton	Menetapkan URL yang akan dibuka saat objek diklik.
setOverflowMenu(menu)	TextButton	Menetapkan menu pop-up yang akan dibuka saat objek diklik.
setText(text)	TextButton	Menetapkan teks yang ditampilkan di tombol.
setTextButtonStyle(textButtonStyle)	TextButton	Menetapkan gaya tombol.

Dokumentasi mendetail

setAltText(altText)

Menetapkan teks alternatif tombol untuk aksesibilitas. Jika tidak ditetapkan, defaultnya adalah teks yang ditampilkan di tombol.

Parameter

Nama	Jenis	Deskripsi
altText	String	Teks alternatif yang akan ditetapkan ke tombol ini.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

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) yang ditetapkan.

// ...

const 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 saat elemen ini diklik.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setBackgroundColor(backgroundColor)

Menetapkan warna latar belakang untuk tombol TextButtonStyle.FILLED. Jika tidak ditetapkan untuk tombol TextButtonStyle.FILLED, tombol akan menggunakan warna sekunder yang ditentukan dalam manifest add-on. Metode ini tidak berfungsi untuk tombol TextButtonStyle.OUTLINED.

Parameter

Nama	Jenis	Deskripsi
backgroundColor	String	Warna dalam format #rgb.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setComposeAction(action, composedEmailType)

Menetapkan tindakan yang menulis 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) yang ditetapkan.

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

Catatan: Metode ini tidak menetapkan tindakan compose yang digunakan untuk memperluas UI compose. Sebaliknya, metode ini menghubungkan elemen UI ini ke Action yang menulis pesan draf di Apps Script yang dibuka di Gmail saat tindakan selesai.

// ...

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

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const 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 disusun adalah draf mandiri atau balasan.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setDisabled(disabled)

Menetapkan apakah tombol dinonaktifkan. Tombol yang dinonaktifkan berwarna abu-abu dan tidak dapat diklik.

Parameter

Nama	Jenis	Deskripsi
disabled	Boolean	Status dinonaktifkan.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setIcon(icon)

Menetapkan Icon standar untuk ditampilkan di tombol. Ini atau setIconUrl(url) harus digunakan untuk menentukan gambar tombol.

Parameter

Nama	Jenis	Deskripsi
icon	Icon	Salah satu nilai Icon standar.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setIconUrl(url)

Menetapkan URL gambar yang akan digunakan sebagai ikon tombol ini. Ini atau setIcon(icon) harus digunakan untuk menentukan gambar tombol.

Parameter

Nama	Jenis	Deskripsi
url	String	Alamat URL gambar yang dihosting untuk digunakan sebagai ikon tombol ini.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setMaterialIcon(icon)

Menetapkan ikon desain material.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parameter

Nama	Jenis	Deskripsi
icon	MaterialIcon	Ikon desain material.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setOnClickAction(action)

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

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

Nama	Jenis	Deskripsi
action	Action	Tindakan yang akan diambil saat elemen ini diklik.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

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 salah 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).

// ...

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

Nama	Jenis	Deskripsi
action	Action	Objek yang menentukan tindakan buka link yang akan dilakukan saat elemen ini diklik.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setOpenLink(openLink)

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) yang ditetapkan.

Parameter

Nama	Jenis	Deskripsi
openLink	OpenLink	Objek OpenLink yang menjelaskan URL yang akan dibuka.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setOverflowMenu(menu)

Menetapkan menu pop-up yang akan dibuka saat objek diklik. Setiap item dalam menu dapat menentukan tindakan yang akan dipicu saat diklik. Menu bertingkat tidak didukung, tindakan untuk item menu tidak boleh menentukan menu tambahan.

Hanya tersedia untuk aplikasi Google Chat. Tidak tersedia untuk Add-on Google Workspace.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Parameter

Nama	Jenis	Deskripsi
menu	OverflowMenu	Objek yang menentukan menu tambahan untuk ditampilkan saat elemen ini diklik.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setText(text)

Menetapkan teks yang ditampilkan di tombol.

Parameter

Nama	Jenis	Deskripsi
text	String	Teks yang muncul di tombol.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.

---

setTextButtonStyle(textButtonStyle)

Menetapkan gaya tombol. Jika tidak ditetapkan, setelan defaultnya adalah tombol TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Parameter

Nama	Jenis	Deskripsi
textButtonStyle	TextButtonStyle	Gaya tombol.

Pulang pergi

TextButton — Objek ini, untuk pembuatan rantai.