דף זה תורגם על ידי 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

שיטה	סוג הערך המוחזר	תיאור קצר
`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).

// ...

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

`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 – האובייקט הזה, לצורך קישור.

`setWrapText(wrapText)`

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

פרמטרים

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

חזרה

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