Class Action

פעולה

פעולה שמאפשרת אינטראקטיביות בתוך רכיבים בממשק המשתמש. הפעולה לא מתבצעת ישירות הלקוח מפעיל פונקציית קריאה חוזרת ב-Apps Script עם פרמטרים אופציונליים.

ההגדרה זמינה לתוספים ל-Google Workspace ולאפליקציות של Google Chat.

var image = CardService.newImage()
    .setOnClickAction(CardService.newAction()
        .setFunctionName("handleImageClick")
        .setParameters({imageSrc: 'carImage'}));

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
addRequiredWidget(requiredWidget)	Action	הוספה של שמות הווידג'טים שנדרשים לפעולה כדי לשלוח קובץ תקין.
setAllWidgetsAreRequired(allWidgetsAreRequired)	Action	מציין אם הפעולה הזו מחייבת קלט מכל הווידג'טים.
setFunctionName(functionName)	Action	מגדיר את השם של פונקציית הקריאה החוזרת לקריאה.
setInteraction(interaction)	Action	מגדיר את האינטראקציה עם המשתמש, נדרשת רק כשפותחים תיבת דו-שיח.
setLoadIndicator(loadIndicator)	Action	מגדיר את מחוון הטעינה שיוצג בזמן שהפעולה מתבצעת.
setParameters(parameters)	Action	אפשר להעביר פרמטרים מותאמים אישית אל פונקציית הקריאה החוזרת.
setPersistValues(persistValues)	Action	מציין אם ערכי הטופס נקבעים לפי ערכי הלקוח או לפי ערכי השרת אחרי שתגובה לפעולה מעדכנת את Card של הטופס.

שיטות שהוצאו משימוש

שיטה	סוג הערך המוחזר	תיאור קצר
setMethodName(functionName)	Action

מסמכי תיעוד מפורטים

addRequiredWidget(requiredWidget)

הוספה של שמות הווידג'טים שנדרשים לפעולה כדי לשלוח קובץ תקין. אם הווידג'טים מופיעים אין לרשימה הזו ערך כשהפעולה הזו מופעלת, שליחת הטופס מבוטלת.

האפשרות הזו זמינה רק באפליקציות של Google Chat. לא זמינה לתוספים ל-Google Workspace.

var textInput = CardService.newTextInput()
    .setFieldName("text_input_1")
    .setTitle("Text input title")

// Creates a footer button that requires an input from the above TextInput Widget.
var action = CardService.newAction()
    .setFunctionName("notificationCallback")
    .addRequiredWidget("text_input_1");
var fixedFooter =
      CardService
          .newFixedFooter()
          .setPrimaryButton(
              CardService
                  .newTextButton()
                  .setText("help")
                  .setOnClickAction(action));

פרמטרים

שם	סוג	תיאור
requiredWidget	String	שם הווידג'ט שנדרש על ידי הפעולה הזו.

חזרה

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

---

setAllWidgetsAreRequired(allWidgetsAreRequired)

מציין אם הפעולה הזו מחייבת קלט מכל הווידג'טים.

האפשרות הזו זמינה רק באפליקציות של Google Chat. לא זמינה לתוספים ל-Google Workspace.

// Creates a button with an action that requires inputs from all widgets.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setAllWidgetsAreRequired(true));

פרמטרים

שם	סוג	תיאור
allWidgetsAreRequired	Boolean	האם הפעולה מחייבת קלט מכל הווידג'טים. ברירת המחדל היא false

חזרה

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

---

setFunctionName(functionName)

מגדיר את השם של פונקציית הקריאה החוזרת לקריאה. חובה.

פרמטרים

שם	סוג	תיאור
functionName	String	שם הפונקציה. אפשר להשתמש בפונקציות מספריות כלולות, כמו Library.libFunction1.

חזרה

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

---

setInteraction(interaction)

מגדיר את האינטראקציה עם המשתמש, נדרשת רק כשפותחים תיבת דו-שיח. אם לא צוין, האפליקציה מגיב על ידי ביצוע Action, כמו פתיחת קישור או הרצת פונקציה, כרגיל.

האפשרות הזו זמינה רק באפליקציות של Google Chat. לא זמינה לתוספים ל-Google Workspace.

const action = CardService.newAction()
    .setFunctionName('handleDialog')
    .setInteraction(CardService.Interaction.OPEN_DIALOG);

פרמטרים

שם	סוג	תיאור
interaction	Interaction	האינטראקציה שצריך לציין.

חזרה

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

---

setLoadIndicator(loadIndicator)

מגדיר את מחוון הטעינה שיוצג בזמן שהפעולה מתבצעת.

פרמטרים

שם	סוג	תיאור
loadIndicator	LoadIndicator	האינדיקטור שיוצג.

חזרה

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

---

setParameters(parameters)

אפשר להעביר פרמטרים מותאמים אישית אל פונקציית הקריאה החוזרת. זה שינוי אופציונלי.

פרמטרים

שם	סוג	תיאור
parameters	Object	המפתחות והערכים חייבים להיות מחרוזות.

חזרה

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

---

setPersistValues(persistValues)

מציין אם ערכי הטופס נקבעים לפי ערכי הלקוח או לפי ערכי השרת אחרי שתגובה לפעולה מעדכנת את Card של הטופס. כשהערך הוא true, הפרמטר ערכי הלקוח נשארים אחרי תגובת השרת. כשהוא מוגדר לערך false, הערך של מחליפים את ערכי הטופס. ברירת המחדל היא false.

שמירה על ערכי הלקוח עוזרת למנוע מצבים שבהם טופס משתנה באופן בלתי צפוי אחרי שמשתמש מבצע עריכה. לדוגמה, אם משתמש מבצע עריכה ב-TextInput אחרי אבל לפני שהשרת מגיב. אם הערכים נשמרים, צריך לערוך את משתמש שבוצע נותרו אחרי שתגובת השרת מעדכנת את Card; אחרת, ערך הטופס חוזר לערך שהמשתמש שלח במקור לטופס.

שמירה על ערכי לקוח קבועים עלולה להפריע ליכולת של הסקריפט לנקות שדות טופס או לשנות את ערכי הטופס, לכן רצוי להימנע מהפעלת שמירה על עקביות בפונקציונליות מהסוג הזה. ללא באופן עקבי, מומלץ להשתמש ב-LoadIndicator.SPINNER לאירועים, כי הפעולה הזו נועלת את ממשק המשתמש ומונעת פעולות עריכה של משתמשים לפני שהשרת מגיב. לחלופין, אפשר להשתמש בפונקציה LoadIndicator.NONE ולוודא שלכל רכיב בטופס יש onChange פעולה.

// Creates a button with an action that persists the client's values as the on-click action.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setPersistValues(true)
            .setFunctionName('functionName'));

פרמטרים

שם	סוג	תיאור
persistValues	Boolean	הגדרה שקובעת אם לשמור את הערכים באופן קבוע. ברירת המחדל היא false.

חזרה

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

שיטות שהוצאו משימוש

setMethodName(functionName)

הוצא משימוש. כינוי קודם של setFunctionName(functionName).

פרמטרים

שם	סוג	תיאור
functionName	String	שם הפונקציה. אפשר להשתמש בפונקציות מספריות כלולות, כמו Library.libFunction1.

חזרה

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