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

חזרה

‫Switch – האובייקט הזה, לשרשור.