Class TextButton

TextButton

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

זמין לתוספים ל-Google Workspace ולאפליקציות ל-Google Chat.

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
setAltText(altText)	TextButton	הגדרת הטקסט החלופי של הלחצן לצורכי נגישות.
setAuthorizationAction(action)	TextButton	הגדרה של פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשלוחצים על האובייקט.
setBackgroundColor(backgroundColor)	TextButton	הגדרת צבע הרקע של לחצן TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)	TextButton	הגדרת פעולה שיוצרת טיוטת אימייל כשלוחצים על האובייקט.
setDisabled(disabled)	TextButton	הגדרה של מצב הכפתור (מושבת או לא).
setIcon(icon)	TextButton	מגדירים Icon מוגדר מראש שיוצג על הלחצן.
setIconUrl(url)	TextButton	מגדיר את כתובת ה-URL של תמונה שתשמש כסמל של הלחצן הזה.
setMaterialIcon(icon)	TextButton	הגדרת סמל של Material Design.
setOnClickAction(action)	TextButton	הגדרת פעולה שמתבצעת כשלוחצים על האובייקט.
setOnClickOpenLinkAction(action)	TextButton	הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט.
setOpenLink(openLink)	TextButton	הגדרה של כתובת URL שתיפתח כשלוחצים על האובייקט.
setOverflowMenu(menu)	TextButton	הגדרת תפריט קופץ שייפתח כשלוחצים על האובייקט.
setText(text)	TextButton	הגדרת הטקסט שמוצג על הכפתור.
setTextButtonStyle(textButtonStyle)	TextButton	הגדרת סגנון הכפתור.

תיעוד מפורט

setAltText(altText)

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

פרמטרים

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

חזרה

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

---

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	האובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על הרכיב הזה.

חזרה

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

---

setBackgroundColor(backgroundColor)

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

פרמטרים

שם	סוג	תיאור
backgroundColor	String	הצבע בפורמט ‎ #rgb.

חזרה

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

---

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(e) {
  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 שמציין אם הטיוטה המורכבת היא טיוטה עצמאית או טיוטה של תשובה.

חזרה

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

---

setDisabled(disabled)

הגדרה של מצב הכפתור (מושבת או לא). כפתור מושבת מופיע באפור ואי אפשר ללחוץ עליו.

פרמטרים

שם	סוג	תיאור
disabled	Boolean	המצב המושבת.

חזרה

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

---

setIcon(icon)

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

פרמטרים

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

חזרה

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

---

setIconUrl(url)

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

פרמטרים

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

חזרה

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

---

setMaterialIcon(icon)

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

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

פרמטרים

שם	סוג	תיאור
icon	MaterialIcon	סמל של Material Design.

חזרה

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

---

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	הפעולה שתתבצע כשלוחצים על האלמנט הזה.

חזרה

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

---

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	האובייקט שמציין את פעולת פתיחת הקישור שתתבצע כשלוחצים על הרכיב הזה.

חזרה

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

---

setOpenLink(openLink)

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

פרמטרים

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

חזרה

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

---

setOverflowMenu(menu)

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

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

תצוגה מקדימה למפתחים: זמינה כחלק מתוכנית התצוגה המקדימה למפתחים של 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	האובייקט שמציין את תפריט האפשרויות הנוספות שיוצג כשלוחצים על האלמנט הזה.

חזרה

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

---

setText(text)

הגדרת הטקסט שמוצג על הכפתור.

פרמטרים

שם	סוג	תיאור
text	String	הטקסט שמופיע על הכפתור.

חזרה

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

---

setTextButtonStyle(textButtonStyle)

הגדרת סגנון הכפתור. אם לא מגדירים את המדיניות, ברירת המחדל היא לחצן TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

פרמטרים

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

חזרה

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