Class TextInput

TextInput

Widget kolom input yang menerima input teks.

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

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setFieldName(fieldName)TextInputMenetapkan kunci yang mengidentifikasi input teks ini dalam objek peristiwa yang dihasilkan saat ada interaksi UI.
setHint(hint)TextInputMenyetel petunjuk untuk input teks.
setMultiline(multiline)TextInputMenyetel apakah teks input ditampilkan dalam satu baris atau beberapa baris.
setOnChangeAction(action)TextInputMenyetel tindakan yang akan dilakukan setiap kali input teks berubah.
setSuggestions(suggestions)TextInputMenetapkan saran untuk pelengkapan otomatis di kolom teks.
setSuggestionsAction(suggestionsAction)TextInputMenetapkan tindakan callback untuk mengambil saran berdasarkan input pengguna untuk pelengkapan otomatis.
setTitle(title)TextInputMenyetel judul yang akan ditampilkan di atas kolom input.
setValue(value)TextInputMenetapkan nilai yang diisi otomatis 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, harus unik.

Parameter

NamaJenisDeskripsi
fieldNameStringKunci yang digunakan untuk mengidentifikasi input ini.

Return

TextInput — Objek ini, untuk perantaian.


setHint(hint)

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

Parameter

NamaJenisDeskripsi
hintStringPetunjuk teks yang akan ditampilkan di bawah kolom input. Teks ini selalu terlihat.

Return

TextInput — Objek ini, untuk perantaian.


setMultiline(multiline)

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

Parameter

NamaJenisDeskripsi
multilineBooleanSetelan multigaris.

Return

TextInput — Objek ini, untuk perantaian.


setOnChangeAction(action)

Menyetel tindakan yang akan dilakukan setiap kali input teks berubah.

Parameter

NamaJenisDeskripsi
actionActionTindakan yang harus diambil.

Return

TextInput — Objek ini, untuk perantaian.


setSuggestions(suggestions)

Menetapkan saran untuk pelengkapan otomatis di kolom teks.

Parameter

NamaJenisDeskripsi
suggestionsSuggestionsKumpulan saran yang akan digunakan.

Return

TextInput — Objek ini, untuk perantaian.


setSuggestionsAction(suggestionsAction)

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

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

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

// ...

function suggestionCallback(e) {
  var suggestions = CardService.newSuggestions();
  var numSuggestions = parseInt(e.parameter['numSuggestions']);
  for(var i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion('Suggestion ' + i);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

Parameter

NamaJenisDeskripsi
suggestionsActionActionTindakan yang mengambil saran untuk input ini.

Return

TextInput — Objek ini, untuk perantaian.


setTitle(title)

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

Parameter

NamaJenisDeskripsi
titleStringLabel teks untuk input ini.

Return

TextInput — Objek ini, untuk perantaian.


setValue(value)

Menetapkan nilai yang diisi otomatis untuk ditetapkan di kolom input.

Parameter

NamaJenisDeskripsi
valueStringNilai default yang ditempatkan di input. Parameter ini selalu direpresentasikan sebagai string dalam parameter callback formulir.

Return

TextInput — Objek ini, untuk perantaian.