Class OverflowMenuItem

OverflowMenuItem

OverflowMenuItem עם סמל ותווית טקסט. אפשר להשבית את פריט התפריט לפי הצורך.

זמין באפליקציות של 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'));

Methods

שיטהסוג הערך המוחזרתיאור קצר
setAuthorizationAction(action)OverflowMenuItemהגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט.
setComposeAction(action, composedEmailType)OverflowMenuItemהגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט.
setDisabled(disabled)OverflowMenuItemהגדרה של סטטוס ההשבתה של פריט התפריט.
setOnClickAction(action)OverflowMenuItemהגדרת פעולה שתתבצע כשלוחצים על האובייקט.
setOnClickOpenLinkAction(action)OverflowMenuItemהגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט.
setOpenLink(openLink)OverflowMenuItemהגדרת כתובת URL שתפתח כשלוחצים על האובייקט.
setStartIcon(icon)OverflowMenuItemהגדרת הסמל המוביל של פריט התפריט.
setText(text)OverflowMenuItemהגדרת השם של פריט התפריט.

מסמכים מפורטים

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

חזרה

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


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

פרמטרים

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

חזרה

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


setDisabled(disabled)

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

פרמטרים

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

חזרה

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


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

חזרה

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


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

חזרה

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


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

פרמטרים

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

חזרה

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


setStartIcon(icon)

הגדרת הסמל המוביל של פריט התפריט.

פרמטרים

שםסוגתיאור
iconIconImageהסמל שרוצים להציג.

חזרה

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


setText(text)

הגדרת השם של פריט התפריט. חובה.

פרמטרים

שםסוגתיאור
textStringהטקסט שיוצג.

חזרה

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