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 را در یک پنجره جدید باز می کند. هنگامی که کاربر جریان مجوز را تمام کرد و به برنامه بازگشت، افزونه بارگیری مجدد می شود.

یک شی UI فقط می تواند یکی از 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)

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

پارامتر Action باید تابع callback را مشخص کند که یک شی ComposeActionResponse پیکربندی شده با استفاده از ComposeActionResponseBuilder.setGmailDraft(draft) را برمی گرداند.

// ...

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 شیئی که عمل compose را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.
composedEmailType ComposedEmailType یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ.

بازگشت

DecoratedText - این شیء برای زنجیر کردن.

setEndIcon(endIcon)

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

پارامترها

نام تایپ کنید توضیحات
endIcon IconImage نماد برای اضافه کردن.

بازگشت

DecoratedText - این شیء برای زنجیر کردن.

setOnClickAction(action)

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

پارامتر Action باید تابع callback را مشخص کند که یک شی 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 انجام دهید، از این تابع استفاده کنید. یک شی UI فقط می تواند یکی از setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامتر Action باید تابع callback را مشخص کند که یک شی 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 - این شیء برای زنجیر کردن.

یک URL را تنظیم می کند که با کلیک روی شیء باز شود. از این تابع زمانی استفاده کنید که URL از قبل شناخته شده باشد و فقط باید باز شود. یک شی UI فقط می تواند یکی از 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 - این شیء برای زنجیر کردن.