Class KeyValue

KeyValue

Tidak digunakan lagi. Class ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.

Class ini tidak digunakan lagi. Sebagai gantinya, gunakan DecoratedText.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAuthorizationAction(action)KeyValueMenetapkan tindakan otorisasi yang membuka URL ke alur otorisasi saat objek diklik.
setComposeAction(action, composedEmailType)KeyValueMenetapkan tindakan yang membuat draf email saat objek diklik.
setOnClickAction(action)KeyValueMenetapkan tindakan yang dieksekusi saat objek diklik.
setOnClickOpenLinkAction(action)KeyValueMenetapkan tindakan yang membuka URL di tab saat objek diklik.
setOpenLink(openLink)KeyValueMenyetel URL yang akan dibuka saat objek diklik.

Dokumentasi mendetail

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

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

Return

KeyValue — Objek ini, untuk perantaian.


setComposeAction(action, composedEmailType)

Menetapkan tindakan yang membuat draf email 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 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 tersusun adalah draf mandiri atau balasan.

Return

KeyValue — Objek ini, untuk perantaian.


setOnClickAction(action)

Menetapkan tindakan yang dieksekusi 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

KeyValue — Objek ini, untuk perantaian.


setOnClickOpenLinkAction(action)

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

// ...

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

KeyValue — Objek ini, untuk perantaian.


Menyetel URL yang akan dibuka saat objek diklik. Gunakan fungsi ini saat URL sudah diketahui dan hanya perlu dibuka. Objek UI hanya dapat memiliki satu dari kumpulan setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action), atau setComposeAction(action, composedEmailType).

Parameter

NamaJenisDeskripsi
openLinkOpenLinkObjek OpenLink yang menjelaskan URL yang akan dibuka.

Return

KeyValue — Objek ini, untuk perantaian.

Metode yang tidak digunakan lagi