דף זה תורגם על ידי Cloud Translation API.

Class DecoratedText

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

זמין לתוספים ל-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

שיטה	סוג הערך שמוחזר	תיאור קצר
`addEventAction(eventAction)`	`Widget`	הוספה של פעולת האירוע שאפשר לבצע בווידג'ט.
`setAuthorizationAction(action)`	`DecoratedText`	הגדרה של פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשלוחצים על האובייקט.
`setBottomLabel(text)`	`DecoratedText`	מגדיר את טקסט התווית שישמש כמפתח ויוצג מתחת לתוכן הטקסט.
`setButton(button)`	`DecoratedText`	הגדרה של `Button` שמוצג משמאל לטקסט.
`setComposeAction(action, composedEmailType)`	`DecoratedText`	הגדרת פעולה שיוצרת טיוטת אימייל כשלוחצים על האובייקט.
`setEndIcon(endIcon)`	`DecoratedText`	מגדיר את `IconImage` האופציונלי שמוצג משמאל לתוכן.
`setId(id)`	`Widget`	מגדיר את המזהה הייחודי שהוקצה ומשמש לזיהוי הווידג'ט שצריך לשנות.
`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`	מגדיר את טקסט התווית שישמש כמפתח ויוצג מעל תוכן הטקסט.
`setVisibility(visibility)`	`Widget`	הגדרה של רמת החשיפה של הווידג'ט.
`setWrapText(wrapText)`	`DecoratedText`	מגדירה אם טקסט הערך יוצג בשורה אחת או בכמה שורות.

תיעוד מפורט

`addEventAction(eventAction)`

הוספה של פעולת האירוע שאפשר לבצע בווידג'ט.

פרמטרים

שם	סוג	תיאור
`eventAction`	`EventAction`	ה-`EventAction` שרוצים להוסיף.

חזרה

‫Widget – האובייקט, לשרשור.

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

פרמטרים

שם	סוג	תיאור
`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 כשהפעולה מסתיימת.

// ...

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

חזרה

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

`setEndIcon(endIcon)`

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

פרמטרים

שם	סוג	תיאור
`endIcon`	`IconImage`	הסמל שרוצים להוסיף.

חזרה

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

`setId(id)`

מגדיר את המזהה הייחודי שהוקצה ומשמש לזיהוי הווידג'ט שצריך לשנות. שינוי של ווידג'ט נתמך רק בתוספים.

פרמטרים

שם	סוג	תיאור
`id`	`String`	המזהה של הווידג'ט, עם מגבלה של 64 תווים ובפורמט ‎ `[a-zA-Z0-9-]+`‎.

חזרה

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

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

פרמטרים

שם	סוג	תיאור
`action`	`Action`	הפעולה שתתבצע כשלוחצים על האלמנט הזה.

חזרה

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

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

פרמטרים

שם	סוג	תיאור
`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 – האובייקט הזה, לשרשור.

`setVisibility(visibility)`

הגדרה של רמת החשיפה של הווידג'ט. ערך ברירת המחדל הוא `VISIBLE`.

פרמטרים

שם	סוג	תיאור
`visibility`	`Visibility`	ה`Visibility` של הווידג'ט.

חזרה

‫Widget – האובייקט, לשרשור.

`setWrapText(wrapText)`

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

פרמטרים

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

חזרה

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

Class DecoratedText קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

Methods

תיעוד מפורט

addEventAction(eventAction)

פרמטרים

חזרה

setAuthorizationAction(action)

פרמטרים

חזרה

setBottomLabel(text)

פרמטרים

חזרה

setButton(button)

פרמטרים

חזרה

setComposeAction(action, composedEmailType)

פרמטרים

חזרה

setEndIcon(endIcon)

פרמטרים

חזרה

setId(id)

פרמטרים

חזרה

setOnClickAction(action)

פרמטרים

חזרה

setOnClickOpenLinkAction(action)

פרמטרים

חזרה

setOpenLink(openLink)

פרמטרים

חזרה

setStartIcon(startIcon)

פרמטרים

חזרה

setSwitchControl(switchToSet)

פרמטרים

חזרה

setText(text)

פרמטרים

חזרה

setTopLabel(text)

פרמטרים

חזרה

setVisibility(visibility)

פרמטרים

חזרה

setWrapText(wrapText)

פרמטרים

חזרה

Class DecoratedText

`addEventAction(eventAction)`

`setAuthorizationAction(action)`

`setBottomLabel(text)`

`setButton(button)`

`setComposeAction(action, composedEmailType)`

`setEndIcon(endIcon)`

`setId(id)`

`setOnClickAction(action)`

`setOnClickOpenLinkAction(action)`

`setOpenLink(openLink)`

`setStartIcon(startIcon)`

`setSwitchControl(switchToSet)`

`setText(text)`

`setTopLabel(text)`

`setVisibility(visibility)`

`setWrapText(wrapText)`