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	القيمة المرتبطة بالاسم عندما يكون المفتاح مفعّلاً عند إرسال هذا الإجراء إلى callback في النموذج، يتم تمثيله دائمًا كسلسلة.

الإرجاع

Switch: هذا العنصر، لإنشاء سلسلة.