ווידג'ט שמוצג בו טקסט עם קישוטים אופציונליים. מפתחות אפשריים כוללים סמל, תווית למעלה ותווית למטה. כדי להגדיר את תוכן הטקסט ואחד מהמפתחות, צריך להשתמש ב-set
ובאחד מהמפתחות Decorated
, Decorated
, set
או set
. הכיתה הזו מיועדת להחליף את
.
Key
התכונה זמינה בתוספים של Google Workspace ובאפליקציות של Google Chat.
const decoratedText = CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel'); const multilineDecoratedText = CardService.newDecoratedText() .setText('Text') .setTopLabel('TopLabel') .setWrapText(true) .setBottomLabel('BottomLabel');
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
set | Decorated | הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט. |
set | Decorated | מגדיר את טקסט התווית שישמש כמפתח, ומוצג מתחת לתוכן הטקסט. |
set | Decorated | הגדרת Button שמוצג משמאל לטקסט. |
set | Decorated | הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. |
set | Decorated | מגדיר את האפשרות האופציונלית Icon שמוצגת בצד שמאל של התוכן. |
set | Decorated | הגדרת פעולה שתתבצע כשלוחצים על האובייקט. |
set | Decorated | הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. |
set | Decorated | הגדרת כתובת URL שתפתח כשלוחצים על האובייקט. |
set | Decorated | מגדיר את הערך האופציונלי Icon כך שיוצג לפני תוכן הטקסט. |
set | Decorated | הגדרת Switch שמוצגת בצד שמאל של התוכן. |
set | Decorated | הגדרת הטקסט שישמש כערך. |
set | Decorated | מגדיר את טקסט התווית שישמש כמפתח, ומוצג מעל תוכן הטקסט. |
set | Decorated | מגדיר אם טקסט הערך יוצג בשורה אחת או בכמה שורות. |
מסמכים מפורטים
set Authorization Action(action)
הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט. כתובת ה-URL תיפתח בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה וחוזר לאפליקציה, התוסף נטען מחדש.
אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Authorization | האובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על האלמנט הזה. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Bottom Label(text)
מגדיר את טקסט התווית שישמש כמפתח, ומוצג מתחת לתוכן הטקסט.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | טקסט התווית. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Button(button)
הגדרת ה-Button
שמוצג משמאל לטקסט. Decorated
יכול לתמוך רק בלחצן אחד או במתג אחד.
פרמטרים
שם | סוג | תיאור |
---|---|---|
button | Button | הלחצן להוספה. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Compose Action(action, composedEmailType)
הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את הערכים set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Compose
שמוגדר באמצעות Compose
.
// ... 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את פעולת הכתיבה שתתבצע כשמקישים על הרכיב הזה. |
composed | Composed | ערך enum שמציין אם טיוטת ההודעה שנוצרה היא טיוטה עצמאית או טיוטת תשובה. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set End Icon(endIcon)
מגדיר את האפשרות האופציונלית Icon
שמוצגת בצד שמאל של התוכן. Decorated
יכול לתמוך רק בלחצן אחד, במתג אחד או בסמל אחד.
פרמטרים
שם | סוג | תיאור |
---|---|---|
end | Icon | הסמל שרוצים להוסיף. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set On Click Action(action)
הגדרת פעולה שתתבצע כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Action
.
// ... 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | הפעולה שתתבצע כשלוחצים על האלמנט הזה. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set On Click Open Link Action(action)
הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשצריך ליצור את כתובת ה-URL או כשצריך לבצע פעולות אחרות בנוסף ליצירת האובייקט Open
. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Action
שמוגדר באמצעות Action
.
// ... 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את הפעולה של פתיח הקישור שתתבצע כשמקישים על הרכיב הזה. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Open Link(openLink)
הגדרת כתובת URL שתפתח כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשכתובת ה-URL כבר ידועה וצריך רק לפתוח אותה. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
open | Open | אובייקט Open שמתאר את כתובת ה-URL שרוצים לפתוח. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Start Icon(startIcon)
מגדיר את הערך האופציונלי Icon
כך שיוצג לפני תוכן הטקסט.
פרמטרים
שם | סוג | תיאור |
---|---|---|
start | Icon | הסמל שרוצים להציג. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Switch Control(switchToSet)
הגדרת Switch
שמוצגת בצד שמאל של התוכן. Decorated
יכול לתמוך רק בלחצן אחד או במתג אחד.
פרמטרים
שם | סוג | תיאור |
---|---|---|
switch | Switch | המתג להוספה. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Text(text)
הגדרת הטקסט שישמש כערך. תמיכה בפורמט HTML בסיסי. חובה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | תוכן הטקסט של הווידג'ט הזה. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Top Label(text)
מגדיר את טקסט התווית שישמש כמפתח, ומוצג מעל תוכן הטקסט.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | טקסט התווית. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.
set Wrap Text(wrapText)
מגדיר אם טקסט הערך יוצג בשורה אחת או בכמה שורות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
wrap | Boolean | אם הערך הוא true , הטקסט ינותק ויוצג בכמה שורות. אחרת, הטקסט נחתך. |
חזרה
Decorated
– האובייקט הזה, לצורך קישור.