Class SelectionInput

ورودی انتخاب

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

فقط از اعتبارسنجی ارسال فرم برای منوهای Selection Input Type.DROP_DOWN و Selection Input Type.MULTI_SELECT پشتیبانی می‌کند. وقتی Action.setAllWidgetsAreRequired(allWidgetsAreRequired) روی true تنظیم شده باشد یا این ویجت از طریق Action.addRequiredWidget(requiredWidget) مشخص شده باشد، عملیات ارسال مسدود می‌شود مگر اینکه مقداری انتخاب شود.

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

روش‌ها

روش نوع بازگشتی شرح مختصر
add Data Source Config(dataSourceConfig) Selection Input پیکربندی‌های منبع داده را برای کنترل انتخاب تنظیم می‌کند.
add Event Action(eventAction) Widget رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.
add Item(text, value, selected) Selection Input یک آیتم جدید اضافه می‌کند که می‌توان آن را انتخاب کرد.
add Multi Select Item(text, value, selected, startIconUri, bottomText) Selection Input یک آیتم جدید اضافه می‌کند که می‌تواند برای منوهای چند انتخابی انتخاب شود.
set External Data Source(action) Selection Input منبع داده خارجی، مانند یک پایگاه داده رابطه‌ای را تنظیم می‌کند.
set Field Name(fieldName) Selection Input کلیدی را تنظیم می‌کند که این ورودی انتخاب را در شیء رویدادی که هنگام تعامل با رابط کاربری ایجاد می‌شود، شناسایی می‌کند.
set Id(id) Widget شناسه منحصر به فرد اختصاص داده شده برای شناسایی ویجت مورد نظر برای تغییر را تنظیم می‌کند.
set Multi Select Max Selected Items(maxSelectedItems) Selection Input حداکثر تعداد مواردی را که کاربر می‌تواند انتخاب کند، تنظیم می‌کند.
set Multi Select Min Query Length(queryLength) Selection Input تعداد کاراکترهای متنی که کاربر قبل از تکمیل خودکار درخواست‌ها و نمایش موارد پیشنهادی روی کارت، وارد می‌کند را تنظیم می‌کند.
set On Change Action(action) Selection Input هر زمان که ورودی انتخاب تغییر کند، Action را تنظیم می‌کند که انجام شود.
set Platform Data Source(platformDataSource) Selection Input یک منبع داده از Google Workspace تنظیم می‌کند.
set Title(title) Selection Input عنوانی را تنظیم می‌کند که قبل از فیلد ورودی نمایش داده شود.
set Type(type) Selection Input نوع این ورودی را تنظیم می‌کند.
set Visibility(visibility) Widget میزان نمایش ویجت را تنظیم می‌کند.

مستندات دقیق

add Data Source Config(dataSourceConfig)

پیکربندی‌های منبع داده را برای کنترل انتخاب تنظیم می‌کند. این فیلد کنترل دقیق‌تری بر منبع داده ارائه می‌دهد. این یک فیلد اختیاری است.

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

پارامترها

نام نوع توضیحات
data Source Config Data Source Config پیکربندی منبع داده که قرار است روی ورودی انتخاب اعمال شود.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

add Event Action(eventAction)

رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.

پارامترها

نام نوع توضیحات
event Action Event Action Event Action قرار است اضافه شود.

بازگشت

Widget — شیء، برای زنجیره‌سازی.

add Item(text, value, selected)

یک آیتم جدید اضافه می‌کند که می‌توان آن را انتخاب کرد.

پارامترها

نام نوع توضیحات
text Object متنی که برای این آیتم نمایش داده می‌شود. آرگومان‌های اولیه غیر رشته‌ای به طور خودکار به رشته تبدیل می‌شوند.
value Object مقدار ورودی فرم که از طریق تابع فراخوانی ارسال می‌شود. آرگومان‌های اولیه غیر رشته‌ای به طور خودکار به رشته تبدیل می‌شوند.
selected Boolean آیا آیتم به طور پیش‌فرض انتخاب شده است یا خیر. اگر ورودی انتخاب فقط یک مقدار را می‌پذیرد (مانند دکمه‌های رادیویی یا منوی کشویی)، این فیلد را فقط برای یک آیتم تنظیم کنید.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

add Multi Select Item(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 مقدار ورودی فرم که از طریق تابع فراخوانی ارسال می‌شود. آرگومان‌های اولیه غیر رشته‌ای به طور خودکار به رشته تبدیل می‌شوند.
selected Boolean آیا آیتم به طور پیش‌فرض انتخاب شده است یا خیر. اگر ورودی انتخاب فقط یک مقدار را می‌پذیرد (مانند دکمه‌های رادیویی یا منوی کشویی)، این فیلد را فقط برای یک آیتم تنظیم کنید.
start Icon Uri Object برای منوهای چندگزینه‌ای، نشانی اینترنتی (URL) مربوط به آیکون در کنار فیلد متنی آیتم نمایش داده می‌شود. از فایل‌های PNG و JPEG پشتیبانی می‌کند.
bottom Text Object برای منوهای چندگزینه‌ای، یک توضیح متنی یا برچسب که در زیر فیلد متنی آیتم نمایش داده می‌شود.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set External Data Source(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 منبع داده خارجی.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set Field Name(fieldName)

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

پارامترها

نام نوع توضیحات
field Name String نامی که قرار است به این ورودی اختصاص داده شود.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set Id(id)

شناسه منحصر به فردی که برای شناسایی ویجت مورد نظر برای تغییر استفاده می‌شود را تنظیم می‌کند. تغییر ویجت فقط در افزونه‌ها پشتیبانی می‌شود.

پارامترها

نام نوع توضیحات
id String شناسه‌ی ویجت، با محدودیت ۶۴ کاراکتر و با فرمت `[a-zA-Z0-9-]+`.

بازگشت

Widget - این شیء، برای زنجیره‌سازی.

set Multi Select Max Selected Items(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',
        );

پارامترها

نام نوع توضیحات
max Selected Items Integer حداکثر تعداد اقلام.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set Multi Select Min Query Length(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',
        );

پارامترها

نام نوع توضیحات
query Length Integer تعداد کاراکترهای متن.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set On Change Action(action)

هر زمان که ورودی انتخاب تغییر کند، Action را تنظیم می‌کند که انجام شود.

پارامترها

نام نوع توضیحات
action Action اقدامی که باید انجام شود.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set Platform Data Source(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 در دسترس نیست.

پارامترها

نام نوع توضیحات
platform Data Source Platform Data Source منبع داده‌ها.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set Title(title)

عنوانی را تنظیم می‌کند که قبل از فیلد ورودی نمایش داده شود.

پارامترها

نام نوع توضیحات
title String عنوان فیلد ورودی.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set Type(type)

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

پارامترها

نام نوع توضیحات
type Selection Input Type نوع انتخاب.

بازگشت

Selection Input — این شیء، برای زنجیره‌سازی.

set Visibility(visibility)

میزان نمایش ویجت را تنظیم می‌کند. مقدار پیش‌فرض آن `VISIBLE` است.

پارامترها

نام نوع توضیحات
visibility Visibility Visibility ویجت.

بازگشت

Widget — شیء، برای زنجیره‌سازی.