Class Switch

سوئیچ

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

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

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

روش ها

روش نوع برگشت شرح مختصر
setControlType(controlType) Switch نوع کنترل سوئیچ را تنظیم می کند.
setFieldName(fieldName) Switch کلیدی را تنظیم می کند که این سوئیچ را در شی رویدادی که هنگام وجود تعامل رابط کاربری ایجاد می شود، مشخص می کند.
setOnChangeAction(action) Switch زمانی که سوئیچ تغییر می کند، اقدامی را تنظیم می کند.
setSelected(selected) Switch تنظیم می کند که آیا این سوئیچ باید به صورت انتخابی یا انتخاب نشده شروع شود.
setValue(value) Switch مقداری را تنظیم می کند که هنگام روشن شدن این سوئیچ به عنوان ورودی فرم ارسال می شود.

مستندات دقیق

setControlType(controlType)

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

پارامترها

نام تایپ کنید توضیحات
controlType SwitchControlType نوع کنترل سوئیچ

بازگشت

Switch - این شی، برای زنجیر کردن.

setFieldName(fieldName)

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

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

پارامترها

نام تایپ کنید توضیحات
fieldName String کلیدی که برای شناسایی این سوئیچ استفاده می شود.

بازگشت

Switch - این شی، برای زنجیر کردن.

setOnChangeAction(action)

زمانی که سوئیچ تغییر می کند، اقدامی را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
action Action اقدامی که باید هنگام تغییر سوئیچ انجام شود.

بازگشت

Switch - این شی، برای زنجیر کردن.

setSelected(selected)

تنظیم می کند که آیا این سوئیچ باید به صورت انتخابی یا انتخاب نشده شروع شود.

پارامترها

نام تایپ کنید توضیحات
selected Boolean تنظیم وضعیت سوئیچ راه اندازی.

بازگشت

Switch - این شی، برای زنجیر کردن.

setValue(value)

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

پارامترها

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

بازگشت

Switch - این شی، برای زنجیر کردن.