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)

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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


setBackgroundColor(backgroundColor)

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

פרמטרים

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

חזרה

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


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 שמציין אם טיוטת ההודעה שנוצרה היא טיוטה עצמאית או טיוטת תשובה.

חזרה

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


setDisabled(disabled)

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

פרמטרים

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

חזרה

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


setIcon(icon)

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

פרמטרים

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

חזרה

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


setIconUrl(url)

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

פרמטרים

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

חזרה

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


setMaterialIcon(icon)

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

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

פרמטרים

שםסוגתיאור
iconMaterialIconסמל העיצוב של Material.

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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


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

פרמטרים

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

חזרה

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


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

חזרה

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


setText(text)

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

פרמטרים

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

חזרה

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


setTextButtonStyle(textButtonStyle)

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

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

פרמטרים

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

חזרה

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