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.

المَعلمات

الاسمالنوعالوصف
controlTypeSwitchControlTypeنوع عنصر التحكّم في مفتاح التحكّم

استرجاع الكرة

Switch: هذا الكائن، للتسلسل.


setFieldName(fieldName)

لضبط المفتاح الذي يحدّد هذا التبديل في كائن الحدث الذي يتم إنشاؤه عندما يكون هناك تفاعل في واجهة المستخدم. غير مرئية للمستخدم. مطلوبة.

على عكس حقول النموذج الأخرى، لا يلزم أن يكون اسم الحقل هذا فريدًا. يتم إرجاع قيم إدخال النموذج للمبدلات التي تستخدم اسم الحقل نفسه كصفيف. وتتكون الصفيفة من قيم جميع مفاتيح التبديل المفعّلة التي تحمل اسم الحقل هذا.

المَعلمات

الاسمالنوعالوصف
fieldNameStringالمفتاح المستخدم لتحديد مفتاح التبديل هذا.

استرجاع الكرة

Switch: هذا الكائن، للتسلسل.


setOnChangeAction(action)

لضبط الإجراء الذي يتم اتخاذه عند إيقاف مفتاح التبديل.

المَعلمات

الاسمالنوعالوصف
actionActionالإجراء الذي يتم اتخاذه عند إيقاف مفتاح التبديل.

استرجاع الكرة

Switch: هذا الكائن، للتسلسل.


setSelected(selected)

لضبط ما إذا كان يجب أن يبدأ مفتاح التبديل هذا على النحو المحدّد أو غير المحدَّد.

المَعلمات

الاسمالنوعالوصف
selectedBooleanإعداد حالة التبديل للبدء.

استرجاع الكرة

Switch: هذا الكائن، للتسلسل.


setValue(value)

لضبط القيمة التي يتم إرسالها كإدخال للنموذج عند تفعيل مفتاح التبديل هذا.

المَعلمات

الاسمالنوعالوصف
valueStringالقيمة المرتبطة بالاسم عندما يكون مفتاح التبديل في وضع التفعيل. عندما يتم إرسال هذا الرقم إلى معاودة الاتصال بالنموذج، يتم تمثيله دائمًا كسلسلة.

استرجاع الكرة

Switch: هذا الكائن، للتسلسل.