Class ImageButton

ImageButton

ImageButton dengan gambar yang ditampilkan.

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

var imageButton = CardService.newImageButton()
    .setAltText("An image button with an airplane icon.")
    .setIcon(CardService.Icon.AIRPLANE)
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://airplane.com"));

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAltText(altText)ImageButtonMenyetel teks alternatif tombol untuk aksesibilitas.
setAuthorizationAction(action)ImageButtonMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setComposeAction(action, composedEmailType)ImageButtonMenetapkan tindakan yang membuat draf email saat objek diklik.
setIcon(icon)ImageButtonMenyetel Icon yang telah ditentukan untuk ditampilkan pada tombol.
setIconUrl(url)ImageButtonMenyetel URL gambar untuk digunakan sebagai ikon tombol ini.
setOnClickAction(action)ImageButtonMenetapkan tindakan yang dijalankan saat objek diklik.
setOnClickOpenLinkAction(action)ImageButtonMenetapkan tindakan yang akan membuka URL di tab saat objek diklik.
setOpenLink(openLink)ImageButtonMenetapkan URL yang akan dibuka saat objek diklik.

Dokumentasi mendetail

setAltText(altText)

Menyetel teks alternatif tombol untuk aksesibilitas. Wajib.

Parameter

NamaJenisDeskripsi
altTextStringTeks alternatif yang akan ditetapkan ke tombol ini.

Return

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

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

Return

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

ImageButton — Objek ini, untuk perantaian.


setIcon(icon)

Menyetel Icon yang telah ditentukan untuk ditampilkan pada tombol. Entah ini atau setIconUrl(url) harus digunakan untuk menentukan gambar tombol.

Parameter

NamaJenisDeskripsi
iconIconSalah satu nilai Icon yang telah ditentukan sebelumnya.

Return

ImageButton — Objek ini, untuk perantaian.


setIconUrl(url)

Menyetel URL gambar untuk digunakan sebagai ikon tombol ini. Entah ini atau setIcon(icon) harus digunakan untuk menentukan gambar tombol.

Parameter

NamaJenisDeskripsi
urlStringAlamat URL gambar yang dihosting untuk digunakan sebagai ikon tombol ini.

Return

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

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

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

ImageButton — Objek ini, untuk perantaian.