Class SelectionInput

SelectionInput

Một trường nhập dữ liệu cho phép chọn giữa một tập hợp các tuỳ chọn được xác định trước.

Dùng được cho các tiện ích bổ sung của Google Workspace và ứng dụng Google Chat. 

var 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"));

var 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ứcLoại dữ liệu trả vềMô tả ngắn
addItem(text, value, selected)SelectionInputThêm một mục mới có thể chọn được.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputThêm một mục mới có thể chọn được cho trình đơn chọn nhiều mục.
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 đầu vào lựa chọn này trong đối tượng sự kiện được tạo khi có sự tương tác trên giao diện người dùng.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputĐặt số lượng mục tối đa mà một 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 các truy vấn trong ứng dụng tự động hoàn thành và sẽ hiển thị các mục đề xuất trên thẻ.
setOnChangeAction(action)SelectionInputĐặt Action để thực hiện bất cứ khi nào đầu vào lựa chọn thay đổi.
setPlatformDataSource(platformDataSource)SelectionInputThiết lập một nguồn dữ liệu từ Google Workspace.
setTitle(title)SelectionInputĐặt tiêu đề hiển thị trước trường nhập dữ liệu.
setType(type)SelectionInputĐặt kiểu của dữ liệu đầu vào này.

Tài liệu chi tiết

addItem(text, value, selected)

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

Tham số

TênLoạiMô tả
textObjectVăn bản sẽ được hiển thị cho mục này. Đối số gốc không phải chuỗi được chuyển đổi thành tự động.
valueObjectGiá trị nhập vào biểu mẫu được gửi qua lệnh gọi lại. Đối số gốc không phải chuỗi được tự động chuyển đổi thành chuỗi.
selectedBooleanLiệu mục đó có được chọn theo mặc định hay không. Nếu giá trị nhập vào chỉ chấp nhận một giá trị (chẳng hạn như đối với nút chọn hoặc 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 để tạo chuỗi.

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

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

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");

Tham số

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

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"));

Tham 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 để tạo chuỗi.

setFieldName(fieldName)

Đặt khoá xác định đầu vào lựa chọn này trong đối tượng sự kiện được tạo khi có sự 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.

Tham số

TênLoạiMô tả
fieldNameStringTên để gán cho nguồn đầu vào này.

Cầu thủ trả bóng

SelectionInput – Đối tượng này để tạo chuỗi.

setMultiSelectMaxSelectedItems(maxSelectedItems)

Đặt số lượng mục tối đa mà một 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");

Tham số

TênLoạiMô tả
maxSelectedItemsIntegerSố lượng mục tối đa.

Cầu thủ trả bóng

SelectionInput – Đối tượng này để tạo chuỗi.

setMultiSelectMinQueryLength(queryLength)

Đặt số lượng ký tự văn bản mà người dùng nhập trước khi các truy vấn trong ứng dụng tự động hoàn thành và sẽ hiển thị các mụ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");

Tham số

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

Cầu thủ trả bóng

SelectionInput – Đối tượng này để tạo chuỗi.

setOnChangeAction(action)

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

Tham 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 để tạo chuỗi.

setPlatformDataSource(platformDataSource)

Thiết lập một nguồn dữ liệu từ Google Workspace. Dùng để điền các mục trong trình đơn chọn nhiều mục. 

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

Tham số

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

Cầu thủ trả bóng

SelectionInput – Đối tượng này để tạo chuỗi.

setTitle(title)

Đặt tiêu đề hiển thị trước trường nhập dữ liệu.

Tham số

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

Cầu thủ trả bóng

SelectionInput – Đối tượng này để tạo chuỗi.

setType(type)

Đặt kiểu của dữ liệu đầu vào này. Giá trị mặc định là CHECKBOX.

Tham số

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

Cầu thủ trả bóng

SelectionInput – Đối tượng này để tạo chuỗi.