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

Methods

שיטהסוג הערך המוחזרתיאור קצר
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)

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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


setComposeAction(action, composedEmailType)

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

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

// ...

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

// ...

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

פרמטרים

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

חזרה

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


setIcon(icon)

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

פרמטרים

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

חזרה

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


setIconUrl(url)

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

פרמטרים

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

חזרה

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


setImageButtonStyle(imageButtonStyle)

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

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

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

פרמטרים

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

חזרה

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


setMaterialIcon(icon)

הגדרת הסמל של Material Design.

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

פרמטרים

שםסוגתיאור
iconMaterialIconסמל העיצוב של 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();
}

פרמטרים

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

חזרה

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();
}

פרמטרים

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

חזרה

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


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

פרמטרים

שםסוגתיאור
openLinkOpenLinkאובייקט 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();

פרמטרים

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

חזרה

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