Class Action

Tindakan

Tindakan yang memungkinkan interaktivitas dalam elemen UI. Tindakan tidak terjadi secara langsung di klien, tetapi memanggil fungsi callback Apps Script dengan parameter opsional.

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

const image = CardService.newImage().setOnClickAction(
    CardService.newAction().setFunctionName('handleImageClick').setParameters({
      imageSrc: 'carImage'
    }),
);

Metode

Metode	Jenis nilai yang ditampilkan	Deskripsi singkat
addRequiredWidget(requiredWidget)	Action	Menambahkan nama widget yang diperlukan Tindakan ini untuk pengiriman yang valid.
setAllWidgetsAreRequired(allWidgetsAreRequired)	Action	Menunjukkan apakah Tindakan ini memerlukan input dari semua widget.
setFunctionName(functionName)	Action	Menetapkan nama fungsi callback yang akan dipanggil.
setInteraction(interaction)	Action	Menetapkan interaksi dengan pengguna, hanya diperlukan saat membuka dialog.
setLoadIndicator(loadIndicator)	Action	Menetapkan indikator pemuatan yang ditampilkan saat tindakan sedang berlangsung.
setParameters(parameters)	Action	Memungkinkan parameter kustom diteruskan ke fungsi callback.
setPersistValues(persistValues)	Action	Menunjukkan apakah nilai formulir ditentukan oleh nilai klien atau nilai server setelah respons tindakan memperbarui Card formulir.

Metode yang tidak digunakan lagi

Metode	Jenis nilai yang ditampilkan	Deskripsi singkat
setMethodName(functionName)	Action

Dokumentasi mendetail

addRequiredWidget(requiredWidget)

Menambahkan nama widget yang diperlukan Tindakan ini untuk pengiriman yang valid. Jika widget dalam daftar ini tidak memiliki nilai saat Tindakan ini dipanggil, pengiriman formulir akan dibatalkan.

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

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_1')
                      .setTitle('Text input title');

// Creates a footer button that requires an input from the above TextInput
// Widget.
const action = CardService.newAction()
                   .setFunctionName('notificationCallback')
                   .addRequiredWidget('text_input_1');
const fixedFooter = CardService.newFixedFooter().setPrimaryButton(
    CardService.newTextButton().setText('help').setOnClickAction(action),
);

Parameter

Nama	Jenis	Deskripsi
requiredWidget	String	Nama widget yang diperlukan oleh Action ini.

Pulang pergi

Action — Objek ini, untuk dirangkaikan.

---

setAllWidgetsAreRequired(allWidgetsAreRequired)

Menunjukkan apakah Tindakan ini memerlukan input dari semua widget.

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

// Creates a button with an action that requires inputs from all widgets.
const button = CardService.newTextButton()
                   .setText('Create notification')
                   .setOnClickAction(
                       CardService.newAction().setAllWidgetsAreRequired(true));

Parameter

Nama	Jenis	Deskripsi
allWidgetsAreRequired	Boolean	Apakah tindakan memerlukan input dari semua widget. Nilai defaultnya adalah false.

Pulang pergi

Action — Objek ini, untuk dirangkaikan.

---

setFunctionName(functionName)

Menetapkan nama fungsi callback yang akan dipanggil. Wajib.

Parameter

Nama	Jenis	Deskripsi
functionName	String	Nama fungsi. Anda dapat menggunakan fungsi dari pustaka yang disertakan, seperti Library.libFunction1.

Pulang pergi

Action — Objek ini, untuk dirangkaikan.

---

setInteraction(interaction)

Menetapkan interaksi dengan pengguna, hanya diperlukan saat membuka dialog. Jika tidak ditentukan, aplikasi akan merespons dengan menjalankan Action seperti membuka link atau menjalankan fungsi—seperti biasa.

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

const action = CardService.newAction()
                   .setFunctionName('handleDialog')
                   .setInteraction(CardService.Interaction.OPEN_DIALOG);

Parameter

Nama	Jenis	Deskripsi
interaction	Interaction	Interaksi yang akan ditentukan.

Pulang pergi

Action — Objek ini, untuk dirangkaikan.

---

setLoadIndicator(loadIndicator)

Menetapkan indikator pemuatan yang ditampilkan saat tindakan sedang berlangsung.

Parameter

Nama	Jenis	Deskripsi
loadIndicator	LoadIndicator	Indikator yang akan ditampilkan.

Pulang pergi

Action — Objek ini, untuk dirangkaikan.

---

setParameters(parameters)

Memungkinkan parameter kustom diteruskan ke fungsi callback. Opsional.

Parameter

Nama	Jenis	Deskripsi
parameters	Object	Kunci dan nilai harus berupa string.

Pulang pergi

Action — Objek ini, untuk dirangkaikan.

---

setPersistValues(persistValues)

Menunjukkan apakah nilai formulir ditentukan oleh nilai klien atau nilai server setelah respons tindakan memperbarui Card formulir. Jika disetel ke true, nilai klien akan tetap ada setelah respons server. Jika disetel ke false, nilai server akan menggantikan nilai formulir. Defaultnya adalah false.

Mempertahankan nilai klien membantu mencegah situasi saat formulir berubah secara tidak terduga setelah pengguna melakukan pengeditan. Misalnya, jika pengguna mengedit TextInput setelah mengirimkan formulir, tetapi sebelum server merespons. Jika nilai dipertahankan, pengeditan yang dilakukan pengguna akan tetap ada setelah respons server memperbarui Card; jika tidak, nilai formulir akan kembali ke nilai yang awalnya dikirimkan pengguna ke formulir.

Mempertahankan nilai klien dapat mengganggu kemampuan skrip Anda untuk menghapus kolom formulir atau mengganti nilai formulir, jadi hindari mengaktifkan persistensi untuk jenis fungsi tersebut. Tanpa persistensi, sebaiknya Anda menggunakan LoadIndicator.SPINNER untuk peristiwa, karena hal ini mengunci UI dan mencegah pengeditan pengguna sebelum server merespons. Atau, Anda dapat menggunakan LoadIndicator.NONE dan memastikan setiap elemen dalam formulir memiliki tindakan onChange.

// Creates a button with an action that persists the client's values as the
// on-click action.
const button =
    CardService.newTextButton()
        .setText('Create notification')
        .setOnClickAction(
            CardService.newAction().setPersistValues(true).setFunctionName(
                'functionName'),
        );

Parameter

Nama	Jenis	Deskripsi
persistValues	Boolean	Apakah akan mempertahankan nilai. Default-nya adalah false.

Pulang pergi

Action — Objek ini, untuk dirangkaikan.

Metode yang tidak digunakan lagi

setMethodName(functionName)

Tidak digunakan lagi. Alias lama untuk setFunctionName(functionName).

Parameter

Nama	Jenis	Deskripsi
functionName	String	Nama fungsi. Anda dapat menggunakan fungsi dari pustaka yang disertakan, seperti Library.libFunction1.

Pulang pergi

Action — Objek ini, untuk dirangkaikan.