Class DecoratedText

DecoratedText

ווידג'ט שמציג טקסט עם קישוטים אופציונליים. המפתחות האפשריים כוללים סמל, תווית מעל ותווית מתחת. נדרשת הגדרה של תוכן הטקסט ואחד מהמפתחות באמצעות setText(text) ואחד מהמפתחות הבאים: DecoratedText, DecoratedText, setTopLabel(text), או setBottomLabel(text). המחלקה הזו מיועדת להחליף את KeyValue.

אפשר להשתמש בתוספים ל-Google Workspace ובאפליקציות של Google Chat.

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var multilineDecoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel")
    .setWrapText(true)
    .setBottomLabel("BottomLabel");

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
setAuthorizationAction(action)	DecoratedText	מגדירה פעולת הרשאה שפותחת כתובת URL לזרימת ההרשאה כשלוחצים על האובייקט.
setBottomLabel(text)	DecoratedText	מגדיר את טקסט התווית שישמש כמפתח, ומוצג מתחת לתוכן הטקסט.
setButton(button)	DecoratedText	מגדיר את Button שמוצג מימין לטקסט.
setComposeAction(action, composedEmailType)	DecoratedText	מגדירה פעולה שכותבת טיוטת אימייל כשלוחצים על האובייקט.
setEndIcon(endIcon)	DecoratedText	מגדיר את IconImage האופציונלי שמוצג מימין לתוכן.
setOnClickAction(action)	DecoratedText	מגדירה פעולה שמופעלת כשלוחצים על האובייקט.
setOnClickOpenLinkAction(action)	DecoratedText	מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט.
setOpenLink(openLink)	DecoratedText	מגדיר כתובת URL שתיפתח בעקבות לחיצה על האובייקט.
setStartIcon(startIcon)	DecoratedText	מגדיר את המאפיין האופציונלי IconImage שיוצג לפני תוכן הטקסט.
setSwitchControl(switchToSet)	DecoratedText	מגדיר את Switch המוצג מימין לתוכן.
setText(text)	DecoratedText	מגדיר את הטקסט שישמש כערך.
setTopLabel(text)	DecoratedText	מגדיר את טקסט התווית שישמש כמפתח, ומוצג מעל תוכן הטקסט.
setWrapText(wrapText)	DecoratedText	ההגדרה קובעת אם טקסט הערך יוצג בשורה אחת או בכמה שורות.

תיעוד מפורט

setAuthorizationAction(action)

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

החזרות

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

---

setBottomLabel(text)

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

פרמטרים

שם	סוג	תיאור
text	String	טקסט התווית.

החזרות

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

---

setButton(button)

מגדיר את Button שמוצג מימין לטקסט. אפשר להשתמש ב-DecoratedText רק בלחצן אחד או במתג אחד.

פרמטרים

שם	סוג	תיאור
button	Button	הלחצן להוספה.

החזרות

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

---

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

החזרות

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

---

setEndIcon(endIcon)

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

פרמטרים

שם	סוג	תיאור
endIcon	IconImage	הסמל להוספה.

החזרות

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

---

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	הפעולה שצריך לבצע כשמשתמש לוחץ על הרכיב הזה.

החזרות

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

---

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

החזרות

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

---

setOpenLink(openLink)

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

פרמטרים

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

החזרות

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

---

setStartIcon(startIcon)

מגדיר את המאפיין האופציונלי IconImage שיוצג לפני תוכן הטקסט.

פרמטרים

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

החזרות

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

---

setSwitchControl(switchToSet)

מגדיר את Switch המוצג מימין לתוכן. אפשר להשתמש ב-DecoratedText רק בלחצן אחד או במתג אחד.

פרמטרים

שם	סוג	תיאור
switchToSet	Switch	המתג שרוצים להוסיף.

החזרות

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

---

setText(text)

מגדיר את הטקסט שישמש כערך. תומך בפורמט HTML בסיסי. חובה.

פרמטרים

שם	סוג	תיאור
text	String	תוכן הטקסט בווידג'ט הזה.

החזרות

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

---

setTopLabel(text)

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

פרמטרים

שם	סוג	תיאור
text	String	טקסט התווית.

החזרות

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

---

setWrapText(wrapText)

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

פרמטרים

שם	סוג	תיאור
wrapText	Boolean	אם הערך הוא true, הטקסט גולש ומוצג במספר שורות. אחרת, הטקסט ייחתך.

החזרות

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