Image
עם תמונה מוצגת.
התכונה זמינה בתוספים של 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
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
set | Image | הגדרת הטקסט החלופי של הלחצן לצורכי נגישות. |
set | Image | הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט. |
set | Image | הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. |
set | Image | הגדרת Icon מוגדר מראש שיוצג בלחצן. |
set | Image | הגדרת כתובת ה-URL של תמונה שתשמש כסמל של הלחצן הזה. |
set | Image | הגדרת סגנון הלחצן. |
set | Image | הגדרת הסמל של Material Design. |
set | Image | הגדרת פעולה שתתבצע כשלוחצים על האובייקט. |
set | Image | הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. |
set | Image | הגדרת כתובת URL שתפתח כשלוחצים על האובייקט. |
set | Image | הגדרת תפריט קופץ שייפתח כשלוחצים על האובייקט. |
מסמכים מפורטים
set Alt Text(altText)
הגדרת הטקסט החלופי של הלחצן לצורכי נגישות. חובה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
alt | String | הטקסט החלופי שרוצים להקצות ללחצן הזה. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set Authorization Action(action)
הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט. כתובת ה-URL תיפתח בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה וחוזר לאפליקציה, התוסף נטען מחדש.
אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Authorization | האובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על האלמנט הזה. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set Compose Action(action, composedEmailType)
הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט UI רק את אחת מהאפשרויות הבאות: set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Compose
שמוגדר באמצעות Compose
.
// ... 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את פעולת הכתיבה שתתבצע כשמקישים על הרכיב הזה. |
composed | Composed | ערך enum שמציין אם טיוטת ההודעה שנוצרה היא טיוטה עצמאית או טיוטת תשובה. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set Icon(icon)
הגדרת Icon
מוגדר מראש שיוצג בלחצן. צריך להשתמש באפשרות הזו או באפשרות set
כדי להגדיר את תמונת הלחצן.
פרמטרים
שם | סוג | תיאור |
---|---|---|
icon | Icon | אחד מערכי Icon שהוגדרו מראש. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set Icon Url(url)
הגדרת כתובת ה-URL של תמונה שתשמש כסמל של הלחצן הזה. צריך להשתמש באפשרות הזו או באפשרות set
כדי להגדיר את תמונת הלחצן.
פרמטרים
שם | סוג | תיאור |
---|---|---|
url | String | כתובת ה-URL של תמונה מתארחת שתשמש כסמל של הלחצן הזה. |
חזרה
Image
– האובייקט הזה, לצורך שרשור.
set Image Button Style(imageButtonStyle)
הגדרת סגנון הלחצן. אם לא מגדירים את הפרמטר, ברירת המחדל היא לחצן Image
.
זמין באפליקציות של Google Chat. בתצוגה המקדימה למפתחים של תוספים ל-Google Workspace.
const imageButton = CardService.newImageButton().setImageButtonStyle( CardService.ImageButtonStyle.BORDERLESS, );
פרמטרים
שם | סוג | תיאור |
---|---|---|
image | Image | סגנון הלחצן. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set Material Icon(icon)
הגדרת הסמל של Material Design.
const imageButton = CardService.newImageButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
פרמטרים
שם | סוג | תיאור |
---|---|---|
icon | Material | סמל העיצוב של Material. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set On Click Action(action)
הגדרת פעולה שתתבצע כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Action
.
// ... 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 | הפעולה שתתבצע כשלוחצים על האלמנט הזה. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set On Click Open Link Action(action)
הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשצריך ליצור את כתובת ה-URL או כשצריך לבצע פעולות אחרות בנוסף ליצירת האובייקט Open
. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Action
שמוגדר באמצעות Action
.
// ... 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 | האובייקט שמציין את הפעולה של פתיח הקישור שתתבצע כשמקישים על הרכיב הזה. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set Open Link(openLink)
הגדרת כתובת URL שתפתח כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשכתובת ה-URL כבר ידועה וצריך רק לפתוח אותה. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
open | Open | אובייקט Open שמתאר את כתובת ה-URL שרוצים לפתוח. |
חזרה
Image
– האובייקט הזה, לצורך קישור.
set Overflow Menu(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 | Overflow | האובייקט שמציין את תפריט האפשרויות הנוספות שיוצג כשלוחצים על האלמנט הזה. |
חזרה
Image
– האובייקט הזה, לצורך קישור.