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

الطُرق

الطريقة	نوع القيمة التي تم إرجاعها	وصف قصير
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: هذا العنصر، للتسلسل