Halaman ini diterjemahkan oleh Cloud Translation API.

Class 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

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

Dokumentasi mendetail

`setAltText(altText)`

Mengatur teks alternatif tombol untuk aksesibilitas. Wajib diisi.

Parameter

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

Pulang pergi

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

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

Pulang pergi

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

Catatan: Metode ini tidak menetapkan tindakan penulisan yang digunakan untuk memperluas UI compose. Namun, metode ini menghubungkan elemen UI ini ke Action yang membuat pesan draf di Apps Script yang dibuka di Gmail setelah 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 merupakan draf mandiri atau balasan.

Pulang pergi

ImageButton — Objek ini, untuk perantaian.

`setIcon(icon)`

Menyetel Icon yang telah ditentukan untuk ditampilkan di tombol. Ini atau setIconUrl(url) harus digunakan untuk menentukan gambar tombol.

Parameter

Nama	Jenis	Deskripsi
`icon`	`Icon`	Salah satu nilai `Icon` yang telah ditetapkan.

Pulang pergi

ImageButton — Objek ini, untuk perantaian.

`setIconUrl(url)`

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

Parameter

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

Pulang pergi

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

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

Pulang pergi

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

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

Pulang pergi

ImageButton — Objek ini, untuk perantaian.

`setOpenLink(openLink)`

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

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

Pulang pergi

ImageButton — Objek ini, untuk perantaian.