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

Class 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 לתהליך ההרשאה כשהאובייקט בוצעה לחיצה. פעולה זו תפתח את כתובת ה-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 – האובייקט הזה, לשרשור.