Class TextInput

TextInput

วิดเจ็ตช่องป้อนข้อมูลที่ยอมรับการป้อนข้อความ

พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace และแอป Google Chat

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

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
setFieldName(fieldName)	TextInput	ตั้งค่าคีย์ที่ระบุอินพุตข้อความนี้ในออบเจ็กต์เหตุการณ์ที่สร้างขึ้นเมื่อมีการทำงานกับ UI
setHint(hint)	TextInput	ตั้งค่าคำแนะนำสำหรับการป้อนข้อความ
setMultiline(multiline)	TextInput	ตั้งค่าว่าข้อความที่ป้อนจะแสดงในบรรทัดเดียวหรือหลายบรรทัด
setOnChangeAction(action)	TextInput	ตั้งค่าการดําเนินการที่จะทําทุกครั้งที่มีการเปลี่ยนแปลงการป้อนข้อความ
setSuggestions(suggestions)	TextInput	ตั้งค่าคำแนะนำสำหรับการเติมข้อความอัตโนมัติในช่องข้อความ
setSuggestionsAction(suggestionsAction)	TextInput	ตั้งค่าการดำเนินการของคอลแบ็กเพื่อดึงข้อมูลคำแนะนำตามข้อมูลที่ผู้ใช้ป้อนสำหรับการเติมข้อความอัตโนมัติ
setTitle(title)	TextInput	ตั้งค่าชื่อที่จะแสดงเหนือช่องป้อนข้อมูล
setValidation(validation)	TextInput	ตั้งค่ากฎการตรวจสอบสําหรับวิดเจ็ตนี้
setValue(value)	TextInput	ตั้งค่าค่าที่กรอกไว้ล่วงหน้าในช่องป้อนข้อมูล

เอกสารประกอบโดยละเอียด

setFieldName(fieldName)

ตั้งค่าคีย์ที่ระบุอินพุตข้อความนี้ในออบเจ็กต์เหตุการณ์ที่สร้างขึ้นเมื่อมีการทำงานกับ UI ผู้ใช้จะมองไม่เห็นข้อมูลนี้ ต้องระบุและต้องเป็นค่าที่ไม่ซ้ำกัน

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
fieldName	String	คีย์ที่ใช้ระบุอินพุตนี้

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setHint(hint)

ตั้งค่าคำแนะนำสำหรับการป้อนข้อความ ใช้เพื่อให้คําแนะนําเพิ่มเติมแก่ผู้ใช้เกี่ยวกับสิ่งที่ต้องป้อน ตัวอย่างเช่น คำแนะนำอาจอธิบายการจัดรูปแบบ ("xxx-xxx-xxxx") สำหรับช่องหมายเลขโทรศัพท์

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
hint	String	คำแนะนำข้อความที่จะแสดงใต้ช่องป้อนข้อมูล ข้อความนี้จะปรากฏอยู่เสมอ

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setMultiline(multiline)

ตั้งค่าว่าข้อความที่ป้อนจะแสดงในบรรทัดเดียวหรือหลายบรรทัด

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
multiline	Boolean	การตั้งค่าหลายบรรทัด

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setOnChangeAction(action)

ตั้งค่าการดําเนินการที่จะทําทุกครั้งที่มีการเปลี่ยนแปลงการป้อนข้อความ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
action	Action	สิ่งที่ต้องดำเนินการ

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setSuggestions(suggestions)

ตั้งค่าคำแนะนำสำหรับการเติมข้อความอัตโนมัติในช่องข้อความ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
suggestions	Suggestions	คอลเล็กชันคําแนะนําที่จะใช้

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setSuggestionsAction(suggestionsAction)

ตั้งค่าการดำเนินการของคอลแบ็กเพื่อดึงข้อมูลคำแนะนำตามข้อมูลที่ผู้ใช้ป้อนสำหรับการเติมข้อความอัตโนมัติ พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ 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();
}

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
suggestionsAction	Action	การดำเนินการที่ดึงข้อมูลคำแนะนำสำหรับการป้อนข้อมูลนี้

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setTitle(title)

ตั้งค่าชื่อที่จะแสดงเหนือช่องป้อนข้อมูล ต้องระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
title	String	ป้ายกํากับข้อความสําหรับอินพุตนี้

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setValidation(validation)

ตั้งค่ากฎการตรวจสอบสําหรับวิดเจ็ตนี้

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

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

เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: มีให้ใช้งานในโปรแกรมเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ของ Google Workspace ซึ่งให้สิทธิ์ทดลองใช้ฟีเจอร์บางอย่างก่อนเปิดตัว

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
validation	Validation	กฎการตรวจสอบสําหรับวิดเจ็ต TextInput นี้

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setValue(value)

ตั้งค่าค่าที่กรอกไว้ล่วงหน้าในช่องป้อนข้อมูล

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
value	String	ค่าเริ่มต้นที่อยู่ในอินพุต โดยระบบจะแสดงเป็นสตริงในพารามิเตอร์การเรียกกลับของแบบฟอร์มเสมอ

รีเทิร์น

TextInput — ออบเจ็กต์นี้สําหรับการต่อเชื่อม