Class TextInput

TextInput

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

ใช้ได้กับส่วนเสริมของ Google Workspace และแอป Google Chat

var 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ตั้งชื่อที่จะแสดงเหนือช่องป้อนข้อมูล
setValue(value)TextInputตั้งค่าที่กรอกไว้ล่วงหน้าที่จะตั้งค่าในช่องป้อนข้อมูล

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

setFieldName(fieldName)

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

พารามิเตอร์

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

รีเทิร์น

TextInput — ออบเจ็กต์นี้สำหรับการทำเชน


setHint(hint)

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

พารามิเตอร์

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

รีเทิร์น

TextInput — ออบเจ็กต์นี้สำหรับการทำเชน


setMultiline(multiline)

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

พารามิเตอร์

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

รีเทิร์น

TextInput — ออบเจ็กต์นี้สำหรับการทำเชน


setOnChangeAction(action)

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

พารามิเตอร์

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

รีเทิร์น

TextInput — ออบเจ็กต์นี้สำหรับการทำเชน


setSuggestions(suggestions)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
suggestionsSuggestionsการรวบรวมคำแนะนำที่จะใช้

รีเทิร์น

TextInput — ออบเจ็กต์นี้สำหรับการทำเชน


setSuggestionsAction(suggestionsAction)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
suggestionsActionActionการดำเนินการที่ดึงคำแนะนำสำหรับอินพุตนี้

รีเทิร์น

TextInput — ออบเจ็กต์นี้สำหรับการทำเชน


setTitle(title)

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

พารามิเตอร์

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

รีเทิร์น

TextInput — ออบเจ็กต์นี้สำหรับการทำเชน


setValue(value)

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

พารามิเตอร์

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

รีเทิร์น

TextInput — ออบเจ็กต์นี้สำหรับการทำเชน