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 – האובייקט הזה, לשרשור.