Class TextInput

InputTeks

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

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setFieldName(fieldName)TextInputMenetapkan kunci yang mengidentifikasi input teks ini dalam objek peristiwa yang dibuat saat ada interaksi UI.
setHint(hint)TextInputMenetapkan petunjuk untuk input teks.
setHostAppDataSource(hostAppDataSource)TextInputMenetapkan sumber data dari aplikasi Google Workspace.
setMultiline(multiline)TextInputMenetapkan apakah teks input ditampilkan dalam satu baris atau beberapa baris.
setOnChangeAction(action)TextInputMenetapkan 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)TextInputMenetapkan judul yang akan ditampilkan di atas kolom input.
setValidation(validation)TextInputMenetapkan aturan validasi untuk widget ini.
setValue(value)TextInputMenetapkan 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 dibuat saat ada interaksi UI. Tidak terlihat oleh pengguna. Wajib diisi, harus unik.

Parameter

NamaJenisDeskripsi
fieldNameStringKunci yang digunakan untuk mengidentifikasi input ini.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

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

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

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

setHostAppDataSource(hostAppDataSource)

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

Hanya tersedia melalui program Gemini Alpha untuk add-on Google Workspace yang memperluas Alur Google Workspace. 

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

NamaJenisDeskripsi
hostAppDataSourceHostAppDataSourceSumber data.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

setMultiline(multiline)

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

Parameter

NamaJenisDeskripsi
multilineBooleanSetelan multiline.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

setOnChangeAction(action)

Menetapkan tindakan yang akan dilakukan setiap kali input teks berubah.

Parameter

NamaJenisDeskripsi
actionActionTindakan yang harus dilakukan.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

setSuggestions(suggestions)

Menetapkan saran untuk pelengkapan otomatis di kolom teks.

Parameter

NamaJenisDeskripsi
suggestionsSuggestionsKumpulan saran yang akan digunakan.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

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

NamaJenisDeskripsi
suggestionsActionActionTindakan yang mengambil saran untuk input ini.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

setTitle(title)

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

Parameter

NamaJenisDeskripsi
titleStringLabel teks untuk input ini.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

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

NamaJenisDeskripsi
validationValidationAturan validasi untuk widget TextInput ini.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.

setValue(value)

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

Parameter

NamaJenisDeskripsi
valueStringNilai default yang ditempatkan dalam input. Nilai ini selalu ditampilkan sebagai string dalam parameter callback formulir.

Pulang pergi

TextInput — Objek ini, untuk pengaitan.