Class Chip

Chip

Chip dengan ikon dan label teks. Anda dapat menonaktifkan chip jika diperlukan.

Tersedia untuk aplikasi Google Chat. Dalam pratinjau developer untuk add-on Google Workspace.

Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu.

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

Metode

Metode	Jenis nilai yang ditampilkan	Deskripsi singkat
setAltText(altText)	Chip	Menetapkan teks alternatif chip untuk aksesibilitas.
setAuthorizationAction(action)	Chip	Menetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setComposeAction(action, composedEmailType)	Chip	Menetapkan tindakan yang menyusun email draf saat objek diklik.
setDisabled(disabled)	Chip	Menetapkan apakah chip dinonaktifkan.
setIcon(icon)	Chip	Menetapkan ikon yang akan digunakan sebagai chip.
setLabel(label)	Chip	Menetapkan judul chip.
setOnClickAction(action)	Chip	Menetapkan tindakan yang dijalankan saat objek diklik.
setOnClickOpenLinkAction(action)	Chip	Menetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)	Chip	Menetapkan URL yang akan dibuka saat objek diklik.

Dokumentasi mendetail

setAltText(altText)

Menetapkan teks alternatif chip untuk aksesibilitas. Jika tidak disetel, defaultnya adalah teks yang ditampilkan di chip.

Parameter

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

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.

---

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 set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

// ...

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

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.

---

setComposeAction(action, composedEmailType)

Menetapkan tindakan yang menyusun email draf saat objek diklik. Objek UI hanya dapat memiliki satu setelan 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 membuat pesan draf di Apps Script yang dibuka di Gmail saat tindakan selesai.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const 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 disusun adalah draf mandiri atau draf balasan.

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.

---

setDisabled(disabled)

Menetapkan apakah chip dinonaktifkan. Chip yang dinonaktifkan berwarna abu-abu dan tidak dapat diklik.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

Parameter

Nama	Jenis	Deskripsi
disabled	Boolean	Status nonaktif.

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.

---

setIcon(icon)

Menetapkan ikon yang akan digunakan sebagai chip.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

Parameter

Nama	Jenis	Deskripsi
icon	IconImage	Salah satu nilai IconImage standar.

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.

---

setLabel(label)

Menetapkan judul chip. Wajib.

const chip = CardService.newChip().setLabel('bug Report');

Parameter

Nama	Jenis	Deskripsi
label	String	Teks yang akan ditampilkan.

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.

---

setOnClickAction(action)

Menetapkan tindakan yang dijalankan saat objek diklik. Objek UI hanya dapat memiliki satu set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

Parameter Action harus menentukan fungsi callback yang menampilkan objek ActionResponse.

// ...

const 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 harus diambil saat elemen ini diklik.

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.

---

setOnClickOpenLinkAction(action)

Menetapkan tindakan yang membuka URL di tab saat objek diklik. Gunakan fungsi ini saat URL perlu dibuat atau saat Anda perlu melakukan tindakan lain selain membuat objek OpenLink. Objek UI hanya dapat memiliki satu set 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).

// ...

const 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 buka link yang akan diambil saat elemen ini diklik.

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.

---

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 satu set setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

Parameter

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

Pulang pergi

Chip — Objek ini, untuk dirangkaikan.