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
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
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 | הגדרה של תפריט קופץ שייפתח כשלוחצים על האובייקט. |
תיעוד מפורט
setAltText(altText)
הגדרת הטקסט החלופי של הלחצן לצורכי נגישות. חובה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
alt | 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 | Authorization | האובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על הרכיב הזה. |
חזרה
ImageButton – האובייקט הזה, לשרשור.
setComposeAction(action, composedEmailType)
הגדרת פעולה שיוצרת טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק אחד מהערכים 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(); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
action | Action | האובייקט שמציין את פעולת ההודעה שצריך לבצע כשלוחצים על הרכיב הזה. |
composed | Composed | ערך 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, );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
image | Image | סגנון הלחצן. |
חזרה
ImageButton – האובייקט הזה, לשרשור.
setMaterialIcon(icon)
הגדרת סמל של Material Design.
const imageButton = CardService.newImageButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
icon | Material | סמל של Material Design. |
חזרה
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).
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
open | Open | אובייקט Open שמתאר את כתובת ה-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 | Overflow | האובייקט שמציין את תפריט האפשרויות הנוספות שיוצג כשלוחצים על האלמנט הזה. |
חזרה
ImageButton – האובייקט הזה, לשרשור.