Halaman ini diterjemahkan oleh Cloud Translation API.

Class 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

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`setAltText(altText)`	`TextButton`	Menyetel 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 membuat draf email saat objek diklik.
`setDisabled(disabled)`	`TextButton`	Menetapkan apakah tombol dinonaktifkan.
`setOnClickAction(action)`	`TextButton`	Menetapkan tindakan yang dijalankan saat objek diklik.
`setOnClickOpenLinkAction(action)`	`TextButton`	Menetapkan tindakan yang akan membuka URL di tab saat objek diklik.
`setOpenLink(openLink)`	`TextButton`	Menetapkan URL yang akan dibuka saat objek diklik.
`setText(text)`	`TextButton`	Menyetel teks yang ditampilkan pada tombol.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Menetapkan gaya tombol.

Dokumentasi mendetail

`setAltText(altText)`

Menyetel teks alternatif tombol untuk aksesibilitas. Jika tidak disetel, setelan default-nya adalah teks yang ditampilkan pada tombol.

Parameter

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

Return

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

Nama	Jenis	Deskripsi
`action`	`AuthorizationAction`	Objek yang menentukan tindakan otorisasi yang akan diambil saat elemen ini diklik.

Return

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 bukan pengoperasian tombol TextButtonStyle.OUTLINED.

Parameter

Nama	Jenis	Deskripsi
`backgroundColor`	`String`	Warna dalam format #RGB.

Return

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

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.

// ...

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

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

Return

TextButton — Objek ini, untuk perantaian.

`setDisabled(disabled)`

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

Parameter

Nama	Jenis	Deskripsi
`disabled`	`Boolean`	Status dinonaktifkan.

Return

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

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

Return

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

Nama	Jenis	Deskripsi
`action`	`Action`	Objek yang menentukan tindakan link terbuka yang akan diambil saat elemen ini diklik.

Return

TextButton — Objek ini, untuk perantaian.

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

Parameter

Nama	Jenis	Deskripsi
`openLink`	`OpenLink`	Objek `OpenLink` yang mendeskripsikan URL yang akan dibuka.

Return

TextButton — Objek ini, untuk perantaian.

`setText(text)`

Menyetel teks yang ditampilkan pada tombol.

Parameter

Nama	Jenis	Deskripsi
`text`	`String`	Teks yang muncul di tombol.

Return

TextButton — Objek ini, untuk perantaian.

`setTextButtonStyle(textButtonStyle)`

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

Parameter

Nama	Jenis	Deskripsi
`textButtonStyle`	`TextButtonStyle`	Gaya tombol.

Return

TextButton — Objek ini, untuk perantaian.