Class CardAction

CardAction

פריט בתפריט שאפשר ללחוץ עליו, שמתווסף לתפריט הכותרת של הכרטיס.

var action = CardService.newAction();
// Finish building the action...

var cardAction = CardService.newCardAction()
    .setText("Card action")
    .setOnClickAction(action);

שיטות

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

תיעוד מפורט

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

פרמטרים

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

החזרות

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

---

setComposeAction(action, composedEmailType)

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

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

הערה: השיטה הזו לא מגדירה פעולת כתיבת שמשמשת להרחבה של ממשק המשתמש של כתיבת הודעות. במקום זאת, השיטה הזו מקשרת את הרכיב בממשק המשתמש ל-Action שכותב טיוטות של הודעות ב-Apps Script, שנפתח ב-Gmail כשהפעולה הושלמה.

// ...

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

פרמטרים

שם	תיאור	התיאור
action	Action	האובייקט שמציין את פעולת הכתיבה שצריך לבצע כשלוחצים על הרכיב הזה.
composedEmailType	ComposedEmailType	ערך enum שמציין אם הטיוטה שנוצרה היא טיוטה של תשובה או טיוטה של תשובה.

החזרות

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

---

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

פרמטרים

שם	תיאור	התיאור
action	Action	הפעולה שצריך לבצע כשלוחצים על הרכיב הזה.

החזרות

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

---

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

פרמטרים

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

החזרות

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

---

setOpenLink(openLink)

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

פרמטרים

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

החזרות

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

---

setText(text)

מגדיר את טקסט התפריט עבור פעולה זו.

פרמטרים

שם	תיאור	התיאור
text	String	טקסט של אפשרות בתפריט.

החזרות

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