Class Action

פעולה

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

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

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

שיטות

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

תיעוד מפורט

setFunctionName(functionName)

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

פרמטרים

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

החזרות

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


setInteraction(interaction)

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

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

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

פרמטרים

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

החזרות

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


setLoadIndicator(loadIndicator)

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

פרמטרים

שםסוגתיאור
loadIndicatorLoadIndicatorהמחוון שצריך להציג.

החזרות

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


setParameters(parameters)

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

פרמטרים

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

החזרות

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

פרמטרים

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

החזרות

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

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