Class SelectionInput

การเลือกอินพุต

ช่องป้อนข้อมูลที่ช่วยให้คุณเลือกจากชุดตัวเลือกที่กำหนดไว้ล่วงหน้าได้

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

const checkboxGroup =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.CHECK_BOX)
        .setTitle('A group of checkboxes. Multiple selections are allowed.')
        .setFieldName('checkbox_field')
        .addItem('checkbox one title', 'checkbox_one_value', false)
        .addItem('checkbox two title', 'checkbox_two_value', true)
        .addItem('checkbox three title', 'checkbox_three_value', true)
        .setOnChangeAction(
            CardService.newAction().setFunctionName('handleCheckboxChange'),
        );

const radioGroup =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.RADIO_BUTTON)
        .setTitle(
            'A group of radio buttons. Only a single selection is allowed.')
        .setFieldName('checkbox_field')
        .addItem('radio button one title', 'radio_one_value', true)
        .addItem('radio button two title', 'radio_two_value', false)
        .addItem('radio button three title', 'radio_three_value', false);

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('multiselect')
        .setTitle('A multi select input example.')
        .addMultiSelectItem(
            'Contact 1',
            'contact-1',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact one description',
            )
        .addMultiSelectItem(
            'Contact 2',
            'contact-2',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact two description',
            )
        .addMultiSelectItem(
            'Contact 3',
            'contact-3',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact three description',
            )
        .addMultiSelectItem(
            'Contact 4',
            'contact-4',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact four description',
            )
        .addMultiSelectItem(
            'Contact 5',
            'contact-5',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact five description',
            )
        .setMultiSelectMaxSelectedItems(3)
        .setMultiSelectMinQueryLength(1);

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
addItem(text, value, selected)	SelectionInput	เพิ่มรายการใหม่ที่เลือกได้
addMultiSelectItem(text, value, selected, startIconUri, bottomText)	SelectionInput	เพิ่มรายการใหม่ที่เลือกได้สำหรับเมนูแบบเลือกหลายรายการ
setExternalDataSource(action)	SelectionInput	ตั้งค่าแหล่งข้อมูลภายนอก เช่น ฐานข้อมูลเชิงสัมพันธ์
setFieldName(fieldName)	SelectionInput	ตั้งค่าคีย์ที่ระบุอินพุตการเลือกนี้ในออบเจ็กต์เหตุการณ์ที่สร้างขึ้นเมื่อมีการทำงานกับ UI
setMultiSelectMaxSelectedItems(maxSelectedItems)	SelectionInput	ตั้งค่าจำนวนรายการสูงสุดที่ผู้ใช้เลือกได้
setMultiSelectMinQueryLength(queryLength)	SelectionInput	กำหนดจำนวนอักขระข้อความที่ผู้ใช้ป้อนก่อนที่แอปจะค้นหาคำที่เติมข้อความอัตโนมัติและแสดงรายการที่แนะนำในการ์ด
setOnChangeAction(action)	SelectionInput	ตั้งค่า Action ให้ทํางานทุกครั้งที่มีการเปลี่ยนแปลงอินพุตการเลือก
setPlatformDataSource(platformDataSource)	SelectionInput	ตั้งค่าแหล่งข้อมูลจาก Google Workspace
setTitle(title)	SelectionInput	ตั้งค่าชื่อที่จะแสดงก่อนช่องป้อนข้อมูล
setType(type)	SelectionInput	ตั้งค่าประเภทของอินพุตนี้

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

addItem(text, value, selected)

เพิ่มรายการใหม่ที่เลือกได้

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
text	Object	ข้อความที่จะแสดงสําหรับรายการนี้ ระบบจะแปลงอาร์กิวเมนต์พื้นฐานที่ไม่ใช่สตริงเป็นสตริงโดยอัตโนมัติ
value	Object	ค่าการป้อนข้อมูลในแบบฟอร์มที่ส่งผ่าน Callback ระบบจะแปลงอาร์กิวเมนต์พื้นฐานที่ไม่ใช่สตริงเป็นสตริงโดยอัตโนมัติ
selected	Boolean	รายการจะเลือกไว้โดยค่าเริ่มต้นหรือไม่ หากอินพุตการเลือกยอมรับเพียงค่าเดียว (เช่น สําหรับปุ่มตัวเลือกหรือเมนูแบบเลื่อนลง) ให้ตั้งค่าช่องนี้สําหรับรายการเดียวเท่านั้น

รีเทิร์น

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

---

addMultiSelectItem(text, value, selected, startIconUri, bottomText)

เพิ่มรายการใหม่ที่เลือกได้สำหรับเมนูแบบเลือกหลายรายการ

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('multiselect')
        .setTitle('A multi select input example.')
        .addMultiSelectItem(
            'Contact 1',
            'contact-1',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact one description',
            )
        .addMultiSelectItem(
            'Contact 2',
            'contact-2',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact two description',
            )
        .addMultiSelectItem(
            'Contact 3',
            'contact-3',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact three description',
            )
        .addMultiSelectItem(
            'Contact 4',
            'contact-4',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact four description',
            )
        .addMultiSelectItem(
            'Contact 5',
            'contact-5',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact five description',
        );

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
text	Object	ข้อความที่จะแสดงสําหรับรายการนี้ ระบบจะแปลงอาร์กิวเมนต์พื้นฐานที่ไม่ใช่สตริงเป็นสตริงโดยอัตโนมัติ
value	Object	ค่าการป้อนข้อมูลในแบบฟอร์มที่ส่งผ่าน Callback ระบบจะแปลงอาร์กิวเมนต์พื้นฐานที่ไม่ใช่สตริงเป็นสตริงโดยอัตโนมัติ
selected	Boolean	รายการจะเลือกไว้โดยค่าเริ่มต้นหรือไม่ หากอินพุตการเลือกยอมรับเพียงค่าเดียว (เช่น สําหรับปุ่มตัวเลือกหรือเมนูแบบเลื่อนลง) ให้ตั้งค่าช่องนี้สําหรับรายการเดียวเท่านั้น
startIconUri	Object	สำหรับเมนูแบบเลือกหลายรายการ ให้ระบุ URL ของไอคอนที่แสดงข้างช่องข้อความของรายการ รองรับไฟล์ PNG และ JPEG
bottomText	Object	สำหรับเมนูแบบเลือกหลายรายการ ให้ใช้คำอธิบายข้อความหรือป้ายกำกับที่แสดงใต้ช่องข้อความของรายการ

รีเทิร์น

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

---

setExternalDataSource(action)

ตั้งค่าแหล่งข้อมูลภายนอก เช่น ฐานข้อมูลเชิงสัมพันธ์

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .addMultiSelectItem(
            'Contact 3',
            'contact-3',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact three description',
            )
        .setMultiSelectMaxSelectedItems(5)
        .setMultiSelectMinQueryLength(2)
        .setExternalDataSource(
            CardService.newAction().setFunctionName('getContacts'),
        );

พารามิเตอร์

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

รีเทิร์น

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

---

setFieldName(fieldName)

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
fieldName	String	ชื่อที่จะกําหนดให้กับอินพุตนี้

รีเทิร์น

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

---

setMultiSelectMaxSelectedItems(maxSelectedItems)

ตั้งค่าจำนวนรายการสูงสุดที่ผู้ใช้เลือกได้

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('multiselect')
        .setTitle('A multi select input example.')
        .setMultiSelectMaxSelectedItems(3)
        .addMultiSelectItem(
            'Contact 1',
            'contact-1',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact one description',
            )
        .addMultiSelectItem(
            'Contact 2',
            'contact-2',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact two description',
            )
        .addMultiSelectItem(
            'Contact 3',
            'contact-3',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact three description',
            )
        .addMultiSelectItem(
            'Contact 4',
            'contact-4',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact four description',
            )
        .addMultiSelectItem(
            'Contact 5',
            'contact-5',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact five description',
        );

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
maxSelectedItems	Integer	จํานวนรายการสูงสุด

รีเทิร์น

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

---

setMultiSelectMinQueryLength(queryLength)

กำหนดจำนวนอักขระข้อความที่ผู้ใช้ป้อนก่อนที่แอปจะค้นหาคำที่เติมข้อความอัตโนมัติและแสดงรายการที่แนะนำในการ์ด

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('multiselect')
        .setTitle('A multi select input example.')
        .setMultiSelectMinQueryLength(1)
        .addMultiSelectItem(
            'Contact 1',
            'contact-1',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact one description',
            )
        .addMultiSelectItem(
            'Contact 2',
            'contact-2',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact two description',
            )
        .addMultiSelectItem(
            'Contact 3',
            'contact-3',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact three description',
            )
        .addMultiSelectItem(
            'Contact 4',
            'contact-4',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact four description',
            )
        .addMultiSelectItem(
            'Contact 5',
            'contact-5',
            false,
            'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
            'Contact five description',
        );

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
queryLength	Integer	จํานวนอักขระข้อความ

รีเทิร์น

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

---

setOnChangeAction(action)

ตั้งค่า Action ให้ทํางานทุกครั้งที่มีการเปลี่ยนแปลงอินพุตการเลือก

พารามิเตอร์

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

รีเทิร์น

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

---

setPlatformDataSource(platformDataSource)

ตั้งค่าแหล่งข้อมูลจาก Google Workspace ใช้เพื่อป้อนข้อมูลรายการในเมนูแบบเลือกหลายรายการ

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setPlatformDataSource(
            CardService.newPlatformDataSource().setCommonDataSource(
                CardService.CommonDataSource.USER,
                ),
        );

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
platformDataSource	PlatformDataSource	แหล่งข้อมูล

รีเทิร์น

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

---

setTitle(title)

ตั้งค่าชื่อที่จะแสดงก่อนช่องป้อนข้อมูล

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
title	String	ชื่อช่องป้อนข้อมูล

รีเทิร์น

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

---

setType(type)

ตั้งค่าประเภทของอินพุตนี้ ค่าเริ่มต้นคือ CHECKBOX

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
type	SelectionInputType	ประเภทการเลือก

รีเทิร์น

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