Class TextInput

TextInput

Widget kolom input yang menerima input teks.

Mendukung validasi pengiriman formulir. Jika Action.setAllWidgetsAreRequired(allWidgetsAreRequired) disetel ke true atau widget ini ditentukan melalui Action.addRequiredWidget(requiredWidget), tindakan pengiriman akan diblokir kecuali jika nilai dimasukkan.

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

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint');

Metode

Metode	Jenis nilai yang ditampilkan	Deskripsi singkat
addEventAction(eventAction)	Widget	Menambahkan tindakan peristiwa yang dapat dilakukan pada widget.
setFieldName(fieldName)	TextInput	Menetapkan kunci yang mengidentifikasi input teks ini dalam objek peristiwa yang dibuat saat ada interaksi UI.
setHint(hint)	TextInput	Menetapkan petunjuk untuk input teks.
setHostAppDataSource(hostAppDataSource)	TextInput	Menetapkan sumber data dari aplikasi Google Workspace.
setId(id)	Widget	Menetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah.
setInputMode(inputMode)	TextInput	Menetapkan apakah kolom input teks ini mendukung penyisipan variabel.
setMultiline(multiline)	TextInput	Menetapkan apakah teks input ditampilkan dalam satu baris atau beberapa baris.
setOnChangeAction(action)	TextInput	Menetapkan tindakan yang akan dilakukan setiap kali input teks berubah.
setSuggestions(suggestions)	TextInput	Menetapkan saran untuk pelengkapan otomatis di kolom teks.
setSuggestionsAction(suggestionsAction)	TextInput	Menetapkan tindakan callback untuk mengambil saran berdasarkan input pengguna untuk pelengkapan otomatis.
setTitle(title)	TextInput	Menetapkan judul yang akan ditampilkan di atas kolom input.
setValidation(validation)	TextInput	Menetapkan aturan validasi untuk widget ini.
setValue(value)	TextInput	Menetapkan nilai yang telah diisi otomatis untuk ditetapkan di kolom input.
setVisibility(visibility)	Widget	Menetapkan visibilitas widget.

Dokumentasi mendetail

addEventAction(eventAction)

Menambahkan tindakan peristiwa yang dapat dilakukan pada widget.

Parameter

Nama	Jenis	Deskripsi
eventAction	EventAction	EventAction yang akan ditambahkan.

Pulang pergi

Widget — Objek, untuk dirangkaikan.

---

setFieldName(fieldName)

Menetapkan kunci yang mengidentifikasi input teks ini dalam objek peristiwa yang dibuat saat ada interaksi UI. Tidak terlihat oleh pengguna. Wajib diisi, harus unik.

Parameter

Nama	Jenis	Deskripsi
fieldName	String	Kunci yang digunakan untuk mengidentifikasi input ini.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setHint(hint)

Menetapkan petunjuk untuk input teks. Digunakan untuk memberikan panduan tambahan kepada pengguna tentang apa yang harus dimasukkan. Misalnya, petunjuk dapat menjelaskan pemformatan ("xxx-xxx-xxxx") untuk kolom nomor telepon.

Parameter

Nama	Jenis	Deskripsi
hint	String	Petunjuk teks yang akan ditampilkan di bawah kolom input. Teks ini selalu terlihat.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setHostAppDataSource(hostAppDataSource)

Menetapkan sumber data dari aplikasi Google Workspace. Saat ini mendukung pengguna dan ruang Chat.

Hanya tersedia untuk add-on Google Workspace yang memperluas Google Workspace Studio.

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

Parameter

Nama	Jenis	Deskripsi
hostAppDataSource	HostAppDataSource	Sumber data.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setId(id)

Menetapkan ID unik yang ditetapkan yang digunakan untuk mengidentifikasi widget yang akan diubah. Mutasi widget hanya didukung di Add-On.

Parameter

Nama	Jenis	Deskripsi
id	String	ID widget, dengan batas 64 karakter dan dalam format `[a-zA-Z0-9-]+`.

Pulang pergi

Widget — Objek ini, untuk dirangkaikan.

---

setInputMode(inputMode)

Menetapkan apakah kolom input teks ini mendukung penyisipan variabel.

Hanya tersedia untuk add-on Google Workspace yang memperluas Google Workspace Studio.

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setInputMode(CardService.TextInputMode.PLAIN_TEXT);

Parameter

Nama	Jenis	Deskripsi
inputMode	TextInputMode	Jenis input yang diizinkan untuk kolom input teks ini, gunakan RICH_TEXT untuk mendukung penyisipan variabel.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setMultiline(multiline)

Menetapkan apakah teks input ditampilkan dalam satu baris atau beberapa baris.

Parameter

Nama	Jenis	Deskripsi
multiline	Boolean	Setelan multiline.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setOnChangeAction(action)

Menetapkan tindakan yang akan dilakukan setiap kali input teks berubah.

Parameter

Nama	Jenis	Deskripsi
action	Action	Tindakan yang harus dilakukan.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setSuggestions(suggestions)

Menetapkan saran untuk pelengkapan otomatis di kolom teks.

Parameter

Nama	Jenis	Deskripsi
suggestions	Suggestions	Kumpulan saran yang akan digunakan.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setSuggestionsAction(suggestionsAction)

Menetapkan tindakan callback untuk mengambil saran berdasarkan input pengguna untuk pelengkapan otomatis. Parameter Action harus menentukan fungsi callback yang menampilkan objek SuggestionsResponse.

const action = CardService.newAction()
                   .setFunctionName('suggestionCallback')
                   .setParameters({numSuggestions: 3});

CardService.newTextInput()
    .setFieldName('option-field')
    .setTitle('Option Selected')
    .setSuggestionsAction(action);

// ...

function suggestionCallback(e) {
  const suggestions = CardService.newSuggestions();
  const numSuggestions = Number.parseInt(e.parameter.numSuggestions);
  for (let i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion(`Suggestion ${i}`);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

Parameter

Nama	Jenis	Deskripsi
suggestionsAction	Action	Tindakan yang mengambil saran untuk input ini.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setTitle(title)

Menetapkan judul yang akan ditampilkan di atas kolom input. Wajib.

Parameter

Nama	Jenis	Deskripsi
title	String	Label teks untuk input ini.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setValidation(validation)

Menetapkan aturan validasi untuk widget ini.

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

Parameter

Nama	Jenis	Deskripsi
validation	Validation	Aturan validasi untuk widget TextInput ini.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setValue(value)

Menetapkan nilai yang telah diisi otomatis untuk ditetapkan di kolom input.

Parameter

Nama	Jenis	Deskripsi
value	String	Nilai default yang ditempatkan dalam input. Nilai ini selalu ditampilkan sebagai string dalam parameter callback formulir.

Pulang pergi

TextInput — Objek ini, untuk dirangkaikan.

---

setVisibility(visibility)

Menetapkan visibilitas widget. Nilai defaultnya adalah `VISIBLE`.

Parameter

Nama	Jenis	Deskripsi
visibility	Visibility	Visibility widget.

Pulang pergi

Widget — Objek, untuk dirangkaikan.