Class Chip

Chip

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

Hanya tersedia untuk aplikasi Google Chat. Tidak tersedia untuk Add-on Google Workspace.

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAltText(altText)ChipMenyetel teks alternatif chip untuk aksesibilitas.
setAuthorizationAction(action)ChipMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setComposeAction(action, composedEmailType)ChipMenetapkan tindakan yang menulis draf email saat objek diklik.
setDisabled(disabled)ChipMenetapkan apakah chip dinonaktifkan.
setIcon(icon)ChipMenetapkan ikon yang akan digunakan sebagai chip.
setLabel(label)ChipMenetapkan judul chip.
setOnClickAction(action)ChipMenetapkan tindakan yang dijalankan saat objek diklik.
setOnClickOpenLinkAction(action)ChipMenetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)ChipMenetapkan URL yang akan dibuka saat objek diklik.

Dokumentasi mendetail

setAltText(altText)

Menyetel teks alternatif chip untuk aksesibilitas. Jika tidak disetel, setelan defaultnya adalah teks yang ditampilkan pada chip.

Parameter

NamaJenisDeskripsi
altTextStringTeks alternatif yang akan ditetapkan ke chip ini.

Pulang pergi

Chip — Objek ini, untuk pembuatan rantai.


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) yang ditetapkan.

// ...

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

Parameter

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

Pulang pergi

Chip — Objek ini, untuk perantaian.


setComposeAction(action, composedEmailType)

Menetapkan tindakan yang menulis 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) yang ditetapkan.

Parameter Action harus menentukan fungsi callback yang menampilkan objek ComposeActionResponse yang dikonfigurasi menggunakan ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

// ...

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

Pulang pergi

Chip — Objek ini, untuk pembuatan rantai.


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

NamaJenisDeskripsi
disabledBooleanStatus dinonaktifkan.

Pulang pergi

Chip — Objek ini, untuk pembuatan rantai.


setIcon(icon)

Menetapkan ikon yang akan digunakan sebagai chip.

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

Parameter

NamaJenisDeskripsi
iconIconImageSalah satu nilai IconImage standar.

Pulang pergi

Chip — Objek ini, untuk pembuatan rantai.


setLabel(label)

Menetapkan judul chip. Wajib.

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

Parameter

NamaJenisDeskripsi
labelStringTeks yang akan ditampilkan.

Pulang pergi

Chip — Objek ini, untuk pembuatan rantai.


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) yang ditetapkan.

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

NamaJenisDeskripsi
actionActionTindakan yang akan diambil saat elemen ini diklik.

Pulang pergi

Chip — Objek ini, untuk perantaian.


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

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

NamaJenisDeskripsi
actionActionObjek yang menentukan tindakan buka link yang akan dilakukan saat elemen ini diklik.

Pulang pergi

Chip — 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) yang ditetapkan.

Parameter

NamaJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang menjelaskan URL yang akan dibuka.

Pulang pergi

Chip — Objek ini, untuk perantaian.