Class DecoratedText

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

פרמטרים

שםסוגתיאור
actionAuthorizationActionהאובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על האלמנט הזה.

חזרה

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


setBottomLabel(text)

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

פרמטרים

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

חזרה

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


setButton(button)

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

פרמטרים

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

חזרה

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


setComposeAction(action, composedEmailType)

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

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse שמוגדר באמצעות ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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

פרמטרים

שםסוגתיאור
actionActionהאובייקט שמציין את פעולת הכתיבה שתתבצע כשמקישים על הרכיב הזה.
composedEmailTypeComposedEmailTypeערך enum שמציין אם טיוטת ההודעה שנוצרה היא טיוטה עצמאית או טיוטת תשובה.

חזרה

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


setEndIcon(endIcon)

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

פרמטרים

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

חזרה

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

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
actionActionהאובייקט שמציין את הפעולה של פתיח הקישור שתתבצע כשמקישים על הרכיב הזה.

חזרה

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


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

פרמטרים

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

חזרה

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


setStartIcon(startIcon)

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

פרמטרים

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

חזרה

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


setSwitchControl(switchToSet)

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

פרמטרים

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

חזרה

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


setText(text)

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

פרמטרים

שםסוגתיאור
textStringתוכן הטקסט של הווידג'ט הזה.

חזרה

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


setTopLabel(text)

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

פרמטרים

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

חזרה

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


setWrapText(wrapText)

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

פרמטרים

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

חזרה

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