Widget kolom input yang menerima input teks.
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 hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
setFieldName(fieldName) | TextInput | Menetapkan kunci yang mengidentifikasi input teks ini dalam objek peristiwa yang dihasilkan saat ada interaksi UI. |
setHint(hint) | TextInput | Menetapkan petunjuk untuk input teks. |
setMultiline(multiline) | TextInput | Menetapkan apakah teks input ditampilkan di 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 sebelumnya untuk ditetapkan di kolom input. |
Dokumentasi mendetail
setFieldName(fieldName)
Menetapkan kunci yang mengidentifikasi input teks ini dalam objek peristiwa yang dihasilkan 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 pembuatan rantai.
setHint(hint)
Menetapkan petunjuk untuk input teks. Digunakan untuk memberikan panduan tambahan kepada pengguna tentang apa yang harus dimasukkan. Misalnya, petunjuk dapat menjelaskan format ("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 pembuatan rantai.
setMultiline(multiline)
Menetapkan apakah teks input ditampilkan dalam satu baris atau beberapa baris.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
multiline | Boolean | Setelan multibaris. |
Pulang pergi
TextInput
— Objek ini, untuk pembuatan rantai.
setOnChangeAction(action)
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 pembuatan rantai.
setSuggestionsAction(suggestionsAction)
Menyetel 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 perantaian.
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 pembuatan rantai.
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 perantaian.
setValue(value)
Menetapkan nilai yang telah diisi sebelumnya untuk ditetapkan di kolom input.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
value | String | Nilai default yang ditempatkan di input. Parameter ini selalu direpresentasikan sebagai string dalam parameter callback formulir. |
Pulang pergi
TextInput
— Objek ini, untuk pembuatan rantai.