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

روش‌ها

روش نوع بازگشتی شرح مختصر
add Event Action(eventAction) Widget رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.
set Authorization Action(action) Decorated Text یک عمل مجوزدهی تنظیم می‌کند که وقتی روی شیء کلیک می‌شود، یک URL به جریان مجوزدهی باز می‌کند.
set Bottom Label(text) Decorated Text متن برچسب را به عنوان کلید تنظیم می‌کند و در زیر محتوای متن نمایش داده می‌شود.
set Button(button) Decorated Text Button را که در سمت راست متن نمایش داده می‌شود، تنظیم می‌کند.
set Compose Action(action, composedEmailType) Decorated Text عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک ایمیل پیش‌نویس ایجاد می‌کند.
set End Icon(endIcon) Decorated Text Icon Image اختیاری که در سمت راست محتوا نمایش داده می‌شود را تنظیم می‌کند.
set Id(id) Widget شناسه منحصر به فرد اختصاص داده شده برای شناسایی ویجت مورد نظر برای تغییر را تنظیم می‌کند.
set On Click Action(action) Decorated Text عملی را تنظیم می‌کند که هنگام کلیک روی شیء اجرا می‌شود.
set On Click Open Link Action(action) Decorated Text عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک URL را در یک برگه باز می‌کند.
set Open Link(openLink) Decorated Text یک URL را تنظیم می‌کند که هنگام کلیک روی شیء باز شود.
set Start Icon(startIcon) Decorated Text Icon Image اختیاری را برای نمایش قبل از محتوای متن تنظیم می‌کند.
set Switch Control(switchToSet) Decorated Text Switch را که در سمت راست محتوا نمایش داده می‌شود، تنظیم می‌کند.
set Text(text) Decorated Text متنی را که قرار است به عنوان مقدار استفاده شود، تنظیم می‌کند.
set Top Label(text) Decorated Text متن برچسب را به عنوان کلید تنظیم می‌کند و در بالای محتوای متن نمایش داده می‌شود.
set Visibility(visibility) Widget میزان نمایش ویجت را تنظیم می‌کند.
set Wrap Text(wrapText) Decorated Text تعیین می‌کند که آیا متن مقدار باید در یک خط یا چند خط نمایش داده شود.

مستندات دقیق

addEventAction(eventAction)

رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.

پارامترها

نام نوع توضیحات
event Action Event Action Event Action قرار است اضافه شود.

بازگشت

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 Authorization Action شیء‌ای که اقدام مجوزدهی را هنگام کلیک روی این عنصر مشخص می‌کند.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setBottomLabel(text)

متن برچسب را به عنوان کلید تنظیم می‌کند و در زیر محتوای متن نمایش داده می‌شود.

پارامترها

نام نوع توضیحات
text String متن برچسب.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setButton(button)

Button را که در سمت راست متن نمایش داده می‌شود، تنظیم می‌کند. یک DecoratedText فقط می‌تواند از یک دکمه یا یک سوئیچ پشتیبانی کند.

پارامترها

نام نوع توضیحات
button Button دکمه برای اضافه کردن.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setComposeAction(action, composedEmailType)

عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک ایمیل پیش‌نویس ایجاد می‌کند. یک شیء UI فقط می‌تواند یکی از موارد 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();
}

پارامترها

نام نوع توضیحات
action Action شیء‌ای که مشخص می‌کند هنگام کلیک روی این عنصر، چه عملی برای نوشتن انجام شود.
composed Email Type Composed Email Type یک مقدار شمارشی که مشخص می‌کند آیا پیش‌نویس نوشته شده، یک پیش‌نویس مستقل است یا پاسخی.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setEndIcon(endIcon)

IconImage اختیاری را که در سمت راست محتوا نمایش داده می‌شود، تنظیم می‌کند. یک DecoratedText فقط می‌تواند از یک دکمه، یک سوئیچ یا یک آیکون پشتیبانی کند.

پارامترها

نام نوع توضیحات
end Icon Icon Image آیکونی که باید اضافه شود.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setId(id)

شناسه منحصر به فردی که برای شناسایی ویجت مورد نظر برای تغییر استفاده می‌شود را تنظیم می‌کند. تغییر ویجت فقط در افزونه‌ها پشتیبانی می‌شود.

پارامترها

نام نوع توضیحات
id String شناسه‌ی ویجت، با محدودیت ۶۴ کاراکتر و با فرمت `[a-zA-Z0-9-]+`.

بازگشت

Widget - این شیء، برای زنجیره‌سازی.

setOnClickAction(action)

عملی را تنظیم می‌کند که هنگام کلیک روی شیء اجرا می‌شود. یک شیء رابط کاربری فقط می‌تواند یکی از موارد setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) را داشته باشد.

پارامتر Action باید یک تابع فراخوانی (callback function) را مشخص کند که یک شیء 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 نیاز به انجام اقدامات دیگری نیز داشته باشید. یک شیء UI فقط می‌تواند یکی از موارد 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 — این شیء، برای زنجیره‌سازی.

یک URL را تنظیم می‌کند که هنگام کلیک روی شیء باز شود. از این تابع زمانی استفاده کنید که URL از قبل شناخته شده است و فقط نیاز به باز شدن دارد. یک شیء UI فقط می‌تواند یکی از setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) را داشته باشد.

پارامترها

نام نوع توضیحات
open Link Open Link یک شیء Open Link که URL مورد نظر برای باز شدن را توصیف می‌کند.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setStartIcon(startIcon)

IconImage اختیاری را برای نمایش قبل از محتوای متن تنظیم می‌کند.

پارامترها

نام نوع توضیحات
start Icon Icon Image آیکونی که نمایش داده می‌شود.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setSwitchControl(switchToSet)

Switch را که در سمت راست محتوا نمایش داده می‌شود، تنظیم می‌کند. یک DecoratedText فقط می‌تواند از یک دکمه یا یک سوئیچ پشتیبانی کند.

پارامترها

نام نوع توضیحات
switch To Set Switch سوئیچی که باید اضافه شود.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setText(text)

متنی را که به عنوان مقدار استفاده می‌شود، تنظیم می‌کند. از قالب‌بندی اولیه HTML پشتیبانی می‌کند. الزامی است.

پارامترها

نام نوع توضیحات
text String محتوای متنی این ویجت.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setTopLabel(text)

متن برچسب را به عنوان کلید تنظیم می‌کند و در بالای محتوای متن نمایش داده می‌شود.

پارامترها

نام نوع توضیحات
text String متن برچسب.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.

setVisibility(visibility)

میزان نمایش ویجت را تنظیم می‌کند. مقدار پیش‌فرض آن `VISIBLE` است.

پارامترها

نام نوع توضیحات
visibility Visibility Visibility ویجت.

بازگشت

Widget — شیء، برای زنجیره‌سازی.

setWrapText(wrapText)

تعیین می‌کند که آیا متن مقدار باید در یک خط یا چند خط نمایش داده شود.

پارامترها

نام نوع توضیحات
wrap Text Boolean اگر true ، متن در چند خط نمایش داده می‌شود. در غیر این صورت متن کوتاه می‌شود.

بازگشت

DecoratedText — این شیء، برای زنجیره‌سازی.