Class Button

Button

מחלקה בסיסית לכל הלחצנים.

ההגדרה זמינה לתוספים ל-Google Workspace ולאפליקציות של Google Chat.

שיטות

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

מסמכי תיעוד מפורטים

setAuthorizationAction(action)

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

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

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

פרמטרים

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

חזרה

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


setComposeAction(action, composedEmailType)

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

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse שהוגדר באמצעות ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

פרמטרים

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

חזרה

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


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

פרמטרים

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

חזרה

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


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

פרמטרים

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

חזרה

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


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

פרמטרים

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

חזרה

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