Class ImageButton

ImageButton

ImageButton עם תמונה מוצגת.

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

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
setAltText(altText)	ImageButton	הגדרת הטקסט החלופי של הלחצן לצורכי נגישות.
setAuthorizationAction(action)	ImageButton	הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט.
setComposeAction(action, composedEmailType)	ImageButton	הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט.
setIcon(icon)	ImageButton	הגדרת Icon מוגדר מראש שיוצג בלחצן.
setIconUrl(url)	ImageButton	הגדרת כתובת ה-URL של תמונה שתשמש כסמל של הלחצן הזה.
setImageButtonStyle(imageButtonStyle)	ImageButton	הגדרת סגנון הלחצן.
setMaterialIcon(icon)	ImageButton	הגדרת הסמל של Material Design.
setOnClickAction(action)	ImageButton	הגדרת פעולה שתתבצע כשלוחצים על האובייקט.
setOnClickOpenLinkAction(action)	ImageButton	מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט.
setOpenLink(openLink)	ImageButton	הגדרת כתובת URL שתיפתח כשלוחצים על האובייקט.
setOverflowMenu(menu)	ImageButton	הגדרת תפריט קופץ שייפתח כשלוחצים על האובייקט.

תיעוד מפורט

setAltText(altText)

הגדרת הטקסט החלופי של הלחצן לצורכי נגישות. חובה.

פרמטרים

שם	סוג	תיאור
altText	String	הטקסט החלופי שרוצים להקצות ללחצן הזה.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setAuthorizationAction(action)

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

אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

פרמטרים

שם	סוג	תיאור
action	AuthorizationAction	האובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על האלמנט הזה.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setComposeAction(action, composedEmailType)

הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחת מהאפשרויות הבאות: setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse שמוגדר באמצעות ComposeActionResponseBuilder.setGmailDraft(draft).

הערה: השיטה הזו לא מגדירה פעולת כתיבת שמשמשת להרחבת ממשק המשתמש של כתיבת. במקום זאת, השיטה הזו מחברת את הרכיב הזה בממשק המשתמש ל-Action שכותב טיוטות של הודעות ב-Apps Script שנפתחות ב-Gmail כשהפעולה הושלמה.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

פרמטרים

שם	סוג	תיאור
action	Action	האובייקט שמציין את פעולת הכתיבה שתתבצע כשלוחצים על האלמנט הזה.
composedEmailType	ComposedEmailType	ערך enum שמציין אם טיוטת ההודעה שנוצרה היא טיוטה עצמאית או טיוטת תשובה.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setIcon(icon)

הגדרה של Icon שהוגדר מראש להצגה בלחצן. צריך להשתמש באפשרות הזו או באפשרות setIconUrl(url) כדי להגדיר את תמונת הלחצן.

פרמטרים

שם	סוג	תיאור
icon	Icon	אחד מהערכים המוגדרים מראש של Icon.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setIconUrl(url)

מגדיר את כתובת ה-URL של תמונה שתשמש כסמל של לחצן זה. צריך להשתמש באפשרות הזו או באפשרות setIcon(icon) כדי להגדיר את תמונת הלחצן.

פרמטרים

שם	סוג	תיאור
url	String	כתובת ה-URL של תמונה מתארחת שתשמש כסמל של הלחצן הזה.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setImageButtonStyle(imageButtonStyle)

הגדרת סגנון הלחצן. אם לא מגדירים את הפרמטר, ברירת המחדל היא לחצן ImageButtonStyle.BORDERLESS.

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

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

פרמטרים

שם	סוג	תיאור
imageButtonStyle	ImageButtonStyle	סגנון הלחצן.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setMaterialIcon(icon)

מגדיר את הסמל של עיצוב החומר.

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

פרמטרים

שם	סוג	תיאור
icon	MaterialIcon	סמל העיצוב של Material.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setOnClickAction(action)

הגדרת פעולה שתתבצע כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

פרמטרים

שם	סוג	תיאור
action	Action	הפעולה שתתבצע כאשר לוחצים על האלמנט הזה.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setOnClickOpenLinkAction(action)

מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשצריך ליצור את כתובת ה-URL או כשצריך לבצע פעולות אחרות בנוסף ליצירת האובייקט OpenLink. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse שמוגדר באמצעות ActionResponseBuilder.setOpenLink(openLink).

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

פרמטרים

שם	סוג	תיאור
action	Action	האובייקט שמציין את פעולת הקישור הפתוחה שצריך לבצע כשלוחצים על הרכיב הזה.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.

---

setOpenLink(openLink)

הגדרת כתובת URL שתיפתח כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשכתובת ה-URL כבר ידועה וצריך רק לפתוח אותה. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחת מהאפשרויות הבאות: setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

פרמטרים

שם	סוג	תיאור
openLink	OpenLink	אובייקט OpenLink שמתאר את כתובת ה-URL שרוצים לפתוח.

חזרה

ImageButton – האובייקט הזה, לצורך שרשור.

---

setOverflowMenu(menu)

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

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

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

פרמטרים

שם	סוג	תיאור
menu	OverflowMenu	האובייקט שמציין את תפריט האפשרויות הנוספות שיוצג כשלוחצים על האלמנט הזה.

חזרה

ImageButton – האובייקט הזה, לצורך קישור.