Class TextButton

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

פרמטרים

חזרה

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

הגדרת פעולת הרשאה שפותחת כתובת 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);

פרמטרים

חזרה

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

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

פרמטרים

חזרה

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

הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחת מהאפשרויות הבאות: 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() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

פרמטרים

חזרה

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

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

פרמטרים

חזרה

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

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

פרמטרים

חזרה

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

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

פרמטרים

חזרה

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

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

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

פרמטרים

חזרה

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

הגדרת פעולה שתתבצע כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את הערכים 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();
}

פרמטרים

חזרה

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

הגדרת פעולה שפותחת כתובת 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();
}

פרמטרים

חזרה

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

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

פרמטרים

חזרה

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

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

התכונה הזו זמינה רק באפליקציות של 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();

פרמטרים

חזרה

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

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

פרמטרים

חזרה

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

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

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

פרמטרים

חזרה

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