דף זה תורגם על ידי Cloud Translation API.

Class ImageButton

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

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

var 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 של תמונה לשימוש כסמל של הלחצן הזה.
`setOnClickAction(action)`	`ImageButton`	מגדירה פעולה שמופעלת כשלוחצים על האובייקט.
`setOnClickOpenLinkAction(action)`	`ImageButton`	מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט.
`setOpenLink(openLink)`	`ImageButton`	מגדיר כתובת URL שתיפתח בעקבות לחיצה על האובייקט.

תיעוד מפורט

`setAltText(altText)`

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

פרמטרים

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

החזרות

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

`setAuthorizationAction(action)`

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

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

// ...

var 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 כשהפעולה מסתיימת.

// ...

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

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var 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 – האובייקט הזה, לשרשור.

`setOnClickAction(action)`

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

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

// ...

var 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).

// ...

var 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 – האובייקט הזה, לשרשור.