این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class SelectionInput

یک فیلد ورودی که امکان انتخاب بین مجموعه ای از گزینه های از پیش تعریف شده را فراهم می کند.

برای افزونه‌های Google Workspace و برنامه‌های 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);

روش ها

روش	نوع برگشت	شرح مختصر
`addItem(text, value, selected)`	`SelectionInput`	یک مورد جدید را اضافه می کند که می تواند انتخاب شود.
`addMultiSelectItem(text, value, selected, startIconUri, bottomText)`	`SelectionInput`	برای منوهای چند انتخابی، مورد جدیدی را اضافه می کند که می تواند انتخاب شود.
`setExternalDataSource(action)`	`SelectionInput`	منبع داده خارجی مانند پایگاه داده رابطه ای را تنظیم می کند.
`setFieldName(fieldName)`	`SelectionInput`	کلیدی را تنظیم می کند که این ورودی انتخاب را در شی رویدادی که در هنگام وجود تعامل رابط کاربری ایجاد می شود، مشخص می کند.
`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`	برای منوهای چند انتخابی، نشانی اینترنتی نماد در کنار فیلد نوشتاری مورد نمایش داده می‌شود. پشتیبانی از فایل های 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)`

کلیدی را تنظیم می کند که این ورودی انتخاب را در شی رویدادی که در هنگام وجود تعامل رابط کاربری ایجاد می شود، مشخص می کند. برای کاربر قابل مشاهده نیست. الزامی، باید منحصر به فرد باشد.

پارامترها

نام	تایپ کنید	توضیحات
`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 در دسترس است. برای افزونه‌های Google Workspace در دسترس نیست.

پارامترها

نام	تایپ کنید	توضیحات
`platformDataSource`	`PlatformDataSource`	منبع داده

بازگشت

SelectionInput - این شیء برای زنجیر کردن.

`setTitle(title)`

عنوان را قرار می دهد تا جلوتر از فیلد ورودی نشان داده شود.

پارامترها

نام	تایپ کنید	توضیحات
`title`	`String`	عنوان فیلد ورودی

بازگشت

SelectionInput - این شیء برای زنجیر کردن.

`setType(type)`

نوع این ورودی را تنظیم می کند. پیش‌فرض CHECKBOX است.

پارامترها

نام	تایپ کنید	توضیحات
`type`	`SelectionInputType`	نوع انتخاب

بازگشت

SelectionInput - این شیء برای زنجیر کردن.