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

روش ها

روش نوع برگشت شرح مختصر
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 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 نوع این ورودی را تنظیم می کند.

مستندات دقیق

add Item(text, value, selected)

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

پارامترها

نام تایپ کنید توضیحات
text Object متنی که باید برای این مورد نشان داده شود. آرگومان های اولیه غیر رشته ای به صورت خودکار به رشته تبدیل می شوند.
value Object مقدار ورودی فرم که از طریق callback ارسال می شود. آرگومان های اولیه غیر رشته ای به صورت خودکار به رشته تبدیل می شوند.
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 مقدار ورودی فرم که از طریق callback ارسال می شود. آرگومان های اولیه غیر رشته ای به صورت خودکار به رشته تبدیل می شوند.
selected Boolean آیا مورد به طور پیش فرض انتخاب شده است یا خیر. اگر ورودی انتخاب فقط یک مقدار را می پذیرد (مانند دکمه های رادیویی یا یک منوی کشویی)، این قسمت را فقط برای یک مورد تنظیم کنید.
start Icon Uri Object برای منوهای چند انتخابی، نشانی اینترنتی نماد در کنار فیلد نوشتاری مورد نمایش داده می‌شود. پشتیبانی از فایل های 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 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 - این شی، برای زنجیر کردن.