Class Switch

سوئیچ

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

برای افزونه‌های Google Workspace و برنامه‌های Google Chat در دسترس است.

const switchDecoratedText =
    CardService.newDecoratedText()
        .setTopLabel('Switch decorated text widget label')
        .setText('This is a decorated text widget with a switch on the right')
        .setWrapText(true)
        .setSwitchControl(
            CardService.newSwitch()
                .setFieldName('form_input_switch_key')
                .setValue('form_input_switch_value')
                .setOnChangeAction(
                    CardService.newAction().setFunctionName(
                        'handleSwitchChange'),
                    ),
        );

روش‌ها

روش نوع بازگشتی شرح مختصر
set Control Type(controlType) Switch نوع کنترل سوئیچ را تنظیم می‌کند.
set Field Name(fieldName) Switch کلیدی را تنظیم می‌کند که این سوئیچ را در شیء رویدادی که هنگام تعامل با رابط کاربری ایجاد می‌شود، مشخص می‌کند.
set On Change Action(action) Switch عملی را که هنگام فعال یا غیرفعال شدن کلید باید انجام شود، تنظیم می‌کند.
set Selected(selected) Switch تعیین می‌کند که آیا این کلید باید به صورت انتخاب شده یا انتخاب نشده شروع به کار کند.
set Value(value) Switch مقداری را که به عنوان ورودی فرم هنگام فعال بودن این دکمه ارسال می‌شود، تنظیم می‌کند.

مستندات دقیق

setControlType(controlType)

نوع کنترل سوئیچ را تنظیم می‌کند. مقدار پیش‌فرض SWITCH است.

پارامترها

نام نوع توضیحات
control Type Switch Control Type نوع کنترل سوئیچی

بازگشت

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

setFieldName(fieldName)

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

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

پارامترها

نام نوع توضیحات
field Name String کلیدی که برای شناسایی این سوئیچ استفاده می‌شود.

بازگشت

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

setOnChangeAction(action)

عملی را که هنگام فعال یا غیرفعال شدن کلید باید انجام شود، تنظیم می‌کند.

پارامترها

نام نوع توضیحات
action Action عملی که هنگام فعال یا غیرفعال بودن کلید باید انجام شود.

بازگشت

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

setSelected(selected)

تعیین می‌کند که آیا این کلید باید به صورت انتخاب شده یا انتخاب نشده شروع به کار کند.

پارامترها

نام نوع توضیحات
selected Boolean تنظیم وضعیت سوئیچ استارت.

بازگشت

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

setValue(value)

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

پارامترها

نام نوع توضیحات
value String مقداری که هنگام روشن بودن سوئیچ به نام مربوط می‌شود. وقتی این مقدار به تابع فراخوانی فرم ارسال می‌شود، همیشه به صورت یک رشته نمایش داده می‌شود.

بازگشت

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