Class TextButton

TextButton

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

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

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAltText(altText)TextButtonMengatur 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 membuat email draf 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)TextButtonMenyetel teks yang ditampilkan di tombol.
setTextButtonStyle(textButtonStyle)TextButtonMenetapkan gaya tombol.

Dokumentasi mendetail

setAltText(altText)

Mengatur teks alternatif tombol untuk aksesibilitas. Jika tidak disetel, defaultnya adalah teks yang yang ditampilkan pada tombol.

Parameter

NamaJenisDeskripsi
altTextStringTeks alternatif yang akan ditetapkan pada tombol ini.

Pulang pergi

TextButton — Objek ini, untuk perantaian.


setAuthorizationAction(action)

Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik. Tindakan ini akan membuka URL di jendela baru. Ketika 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.

// ...

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

Parameter

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

Pulang pergi

TextButton — Objek ini, untuk perantaian.


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 tidak memiliki pengoperasian untuk tombol TextButtonStyle.OUTLINED.

Parameter

NamaJenisDeskripsi
backgroundColorStringWarna dalam format #RGB.

Pulang pergi

TextButton — Objek ini, untuk perantaian.


setComposeAction(action, composedEmailType)

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

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 merupakan draf mandiri atau balasan.

Pulang pergi

TextButton — Objek ini, untuk perantaian.


setDisabled(disabled)

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

Parameter

NamaJenisDeskripsi
disabledBooleanStatus nonaktif.

Pulang pergi

TextButton — Objek ini, untuk perantaian.


setOnClickAction(action)

Menetapkan tindakan yang dijalankan saat objek diklik. Objek UI hanya dapat memiliki salah satu setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType) 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

NamaJenisDeskripsi
actionActionTindakan yang akan dilakukan saat elemen ini diklik.

Pulang pergi

TextButton — Objek ini, untuk perantaian.


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 sebagai tambahan untuk membuat objek OpenLink. Objek UI hanya dapat memiliki salah satu dari setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType) disetel.

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 menetapkan tindakan link terbuka yang akan diambil saat elemen ini diklik.

Pulang pergi

TextButton — Objek ini, untuk perantaian.


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

Parameter

NamaJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang menjelaskan URL yang akan dibuka.

Pulang pergi

TextButton — Objek ini, untuk perantaian.


setText(text)

Menyetel teks yang ditampilkan di tombol.

Parameter

NamaJenisDeskripsi
textStringTeks yang muncul di tombol.

Pulang pergi

TextButton — Objek ini, untuk perantaian.


setTextButtonStyle(textButtonStyle)

Menetapkan gaya tombol. Jika tidak disetel, kebijakan ini akan disetel secara default ke tombol TextButtonStyle.OUTLINED.

Parameter

NamaJenisDeskripsi
textButtonStyleTextButtonStyleGaya tombol.

Pulang pergi

TextButton — Objek ini, untuk perantaian.