Class TextButton

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

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

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAltText(altText)TextButtonMenetapkan teks alternatif tombol untuk aksesibilitas.
setAuthorizationAction(action)TextButtonMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setBackgroundColor(backgroundColor)TextButtonMenetapkan warna latar belakang untuk tombol TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonMenetapkan tindakan yang menulis draf email saat objek diklik.
setDisabled(disabled)TextButtonMenetapkan apakah tombol dinonaktifkan.
setOnClickAction(action)TextButtonMenetapkan tindakan yang dijalankan saat objek diklik.
setOnClickOpenLinkAction(action)TextButtonMenetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)TextButtonMenetapkan URL yang akan dibuka saat objek diklik.
setText(text)TextButtonMenetapkan teks yang ditampilkan di tombol.
setTextButtonStyle(textButtonStyle)TextButtonMenetapkan gaya tombol.

Dokumentasi mendetail

setAltText(altText)

Menetapkan teks alternatif tombol untuk aksesibilitas. Jika tidak disetel, teks yang ditampilkan pada tombol akan didefaultkan ke default.

Parameter

NameJenisDeskripsi
altTextStringTeks alternatif yang akan ditetapkan ke tombol ini.

Return

TextButton — Objek ini, untuk 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 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

TextButton — Objek ini, untuk rantai.


setBackgroundColor(backgroundColor)

Menetapkan warna latar belakang untuk tombol TextButtonStyle.FILLED. Jika tidak disetel untuk tombol TextButtonStyle.FILLED, tombol tersebut akan menggunakan warna sekunder yang ditentukan dalam manifes add-on. Metode ini adalah tanpa pengoperasian untuk tombol TextButtonStyle.TEXT.

Parameter

NameJenisDeskripsi
backgroundColorStringWarna dalam format #rgb.

Return

TextButton — 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

TextButton — Objek ini, untuk rantai.


setDisabled(disabled)

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

Parameter

NameJenisDeskripsi
disabledBooleanStatus dinonaktifkan.

Return

TextButton — 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

TextButton — 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

TextButton — 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

TextButton — Objek ini, untuk rantai.


setText(text)

Menetapkan teks yang ditampilkan di tombol.

Parameter

NameJenisDeskripsi
textStringTeks yang muncul di tombol.

Return

TextButton — Objek ini, untuk rantai.


setTextButtonStyle(textButtonStyle)

Menetapkan gaya tombol. Jika tidak disetel, setelan defaultnya adalah tombol TextButtonStyle.TEXT.

Parameter

NameJenisDeskripsi
textButtonStyleTextButtonStyleGaya tombol.

Return

TextButton — Objek ini, untuk rantai.