Class SelectionInput

SelectionInput

Một trường nhập dữ liệu cho phép chọn trong một nhóm các lựa chọn được xác định trước.

Chỉ hỗ trợ xác thực lượt gửi biểu mẫu cho các trình đơn SelectionInputType.DROP_DOWN và SelectionInputType.MULTI_SELECT. Khi Action.setAllWidgetsAreRequired(allWidgetsAreRequired) được đặt thành true hoặc tiện ích này được chỉ định thông qua Action.addRequiredWidget(requiredWidget), hành động gửi sẽ bị chặn trừ phi bạn chọn một giá trị.

Dành cho tiện ích bổ sung của Google Workspace và ứng dụng 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);

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addDataSourceConfig(dataSourceConfig)SelectionInputĐặt cấu hình nguồn dữ liệu cho chế độ kiểm soát lựa chọn.
addEventAction(eventAction)WidgetThêm thao tác sự kiện có thể thực hiện trên tiện ích.
addItem(text, value, selected)SelectionInputThêm một mục mới có thể chọn.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputThêm một mục mới có thể chọn cho trình đơn chọn nhiều.
setExternalDataSource(action)SelectionInputĐặt nguồn dữ liệu bên ngoài, chẳng hạn như cơ sở dữ liệu quan hệ.
setFieldName(fieldName)SelectionInputĐặt khoá xác định lựa chọn đầu vào này trong đối tượng sự kiện được tạo khi có một hoạt động tương tác trên giao diện người dùng.
setId(id)WidgetĐặt mã nhận dạng duy nhất được chỉ định dùng để xác định tiện ích cần thay đổi.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputĐặt số lượng tối đa các mục mà người dùng có thể chọn.
setMultiSelectMinQueryLength(queryLength)SelectionInputĐặt số lượng ký tự văn bản mà người dùng nhập trước khi ứng dụng truy vấn tính năng tự động hoàn thành và hiển thị các mục được đề xuất trên thẻ.
setOnChangeAction(action)SelectionInputĐặt một Action để thực hiện bất cứ khi nào đầu vào lựa chọn thay đổi.
setPlatformDataSource(platformDataSource)SelectionInputĐặt một nguồn dữ liệu từ Google Workspace.
setTitle(title)SelectionInputĐặt tiêu đề sẽ xuất hiện trước trường nhập.
setType(type)SelectionInputĐặt loại đầu vào này.
setVisibility(visibility)WidgetĐặt chế độ hiển thị của tiện ích.

Tài liệu chi tiết

addDataSourceConfig(dataSourceConfig)

Đặt cấu hình nguồn dữ liệu cho chế độ kiểm soát lựa chọn. Trường này giúp bạn kiểm soát nguồn dữ liệu một cách chi tiết hơn. Đây là trường không bắt buộc. 

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

Thông số

TênLoạiMô tả
dataSourceConfigDataSourceConfigCấu hình nguồn dữ liệu sẽ được áp dụng cho đầu vào lựa chọn.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

addEventAction(eventAction)

Thêm thao tác sự kiện có thể thực hiện trên tiện ích.

Thông số

TênLoạiMô tả
eventActionEventActionEventAction cần thêm.

Cầu thủ trả bóng

Widget – Đối tượng, để liên kết.

addItem(text, value, selected)

Thêm một mục mới có thể chọn.

Thông số

TênLoạiMô tả
textObjectVăn bản sẽ xuất hiện cho mục này. Các đối số nguyên thuỷ không phải chuỗi sẽ tự động được chuyển đổi thành chuỗi.
valueObjectGiá trị đầu vào của biểu mẫu được gửi thông qua lệnh gọi lại. Các đối số nguyên thuỷ không phải chuỗi sẽ tự động được chuyển đổi thành chuỗi.
selectedBooleanMục đó có được chọn theo mặc định hay không. Nếu lựa chọn đầu vào chỉ chấp nhận một giá trị (chẳng hạn như đối với nút radio hoặc một trình đơn thả xuống), chỉ đặt trường này cho một mục.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

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

Thêm một mục mới có thể chọn cho trình đơn chọn nhiều. 

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',
        );

Thông số

TênLoạiMô tả
textObjectVăn bản sẽ xuất hiện cho mục này. Các đối số nguyên thuỷ không phải chuỗi sẽ tự động được chuyển đổi thành chuỗi.
valueObjectGiá trị đầu vào của biểu mẫu được gửi thông qua lệnh gọi lại. Các đối số nguyên thuỷ không phải chuỗi sẽ tự động được chuyển đổi thành chuỗi.
selectedBooleanMục đó có được chọn theo mặc định hay không. Nếu lựa chọn đầu vào chỉ chấp nhận một giá trị (chẳng hạn như đối với nút radio hoặc một trình đơn thả xuống), chỉ đặt trường này cho một mục.
startIconUriObjectĐối với trình đơn chọn nhiều, URL cho biểu tượng xuất hiện bên cạnh trường văn bản của mục. Hỗ trợ tệp PNG và JPEG.
bottomTextObjectĐối với trình đơn chọn nhiều, nội dung mô tả bằng văn bản hoặc nhãn xuất hiện bên dưới trường văn bản của mục.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setExternalDataSource(action)

Đặt nguồn dữ liệu bên ngoài, chẳng hạn như cơ sở dữ liệu quan hệ. 

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'),
        );

Thông số

TênLoạiMô tả
actionActionNguồn dữ liệu bên ngoài.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setFieldName(fieldName)

Đặt khoá xác định lựa chọn đầu vào này trong đối tượng sự kiện được tạo khi có một hoạt động tương tác trên giao diện người dùng. Người dùng không nhìn thấy. Bắt buộc, phải là duy nhất.

Thông số

TênLoạiMô tả
fieldNameStringTên cần chỉ định cho đầu vào này.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setId(id)

Đặt mã nhận dạng duy nhất được chỉ định dùng để xác định tiện ích cần thay đổi. Chỉ có Tiện ích bổ sung mới hỗ trợ thao tác thay đổi tiện ích.

Thông số

TênLoạiMô tả
idStringMã nhận dạng của tiện ích, có giới hạn 64 ký tự và ở định dạng `[a-zA-Z0-9-]+`.

Cầu thủ trả bóng

Widget – Đối tượng này, để liên kết.

setMultiSelectMaxSelectedItems(maxSelectedItems)

Đặt số lượng tối đa các mục mà người dùng có thể chọn. 

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',
        );

Thông số

TênLoạiMô tả
maxSelectedItemsIntegerSố lượng mặt hàng tối đa.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setMultiSelectMinQueryLength(queryLength)

Đặt số lượng ký tự văn bản mà người dùng nhập trước khi ứng dụng truy vấn tính năng tự động hoàn thành và hiển thị các mục được đề xuất trên thẻ. 

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',
        );

Thông số

TênLoạiMô tả
queryLengthIntegerSố lượng ký tự văn bản.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setOnChangeAction(action)

Đặt một Action để thực hiện bất cứ khi nào đầu vào lựa chọn thay đổi.

Thông số

TênLoạiMô tả
actionActionHành động cần thực hiện.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setPlatformDataSource(platformDataSource)

Đặt một nguồn dữ liệu từ Google Workspace. Dùng để điền các mục vào một trình đơn chọn nhiều. 

const multiSelect =
    CardService.newSelectionInput()
        .setType(CardService.SelectionInputType.MULTI_SELECT)
        .setFieldName('contacts')
        .setTitle('Selected contacts')
        .setPlatformDataSource(
            CardService.newPlatformDataSource().setCommonDataSource(
                CardService.CommonDataSource.USER,
                ),
        );
 Chỉ dành cho các ứng dụng Google Chat. Không dùng được cho các tiện ích bổ sung của Google Workspace.

Thông số

TênLoạiMô tả
platformDataSourcePlatformDataSourceNguồn dữ liệu.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setTitle(title)

Đặt tiêu đề sẽ xuất hiện trước trường nhập.

Thông số

TênLoạiMô tả
titleStringTiêu đề của trường nhập.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setType(type)

Đặt loại đầu vào này. Giá trị mặc định là CHECKBOX.

Thông số

TênLoạiMô tả
typeSelectionInputTypeLoại lựa chọn.

Cầu thủ trả bóng

SelectionInput – Đối tượng này, để liên kết.

setVisibility(visibility)

Đặt chế độ hiển thị của tiện ích. Giá trị mặc định là "VISIBLE".

Thông số

TênLoạiMô tả
visibilityVisibilityVisibility của tiện ích.

Cầu thủ trả bóng

Widget – Đối tượng, để liên kết.