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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
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 – האובייקט הזה, לצורך קישור.