Class DecoratedText

متن تزئین شده

ویجتی که متن را با تزئینات اختیاری نمایش می دهد. کلیدهای ممکن عبارتند از یک نماد، یک برچسب در بالا و یک برچسب در زیر. تنظیم محتوای متن و یکی از کلیدها با استفاده از set Text(text) و یکی از Decorated Text ، Decorated Text ، set Top Label(text) یا set Bottom Label(text) مورد نیاز است. این کلاس برای جایگزینی Key Value در نظر گرفته شده است.

برای افزونه‌های Google Workspace و برنامه‌های Google Chat موجود است.

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

روش ها

روش	نوع برگشت	شرح مختصر
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 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 Wrap Text(wrapText)	Decorated Text	تنظیم می کند که متن مقدار باید در یک خط یا چند خط نمایش داده شود.

مستندات دقیق

set Authorization Action(action)

یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند. این URL را در یک پنجره جدید باز می کند. هنگامی که کاربر جریان مجوز را تمام کرد و به برنامه بازگشت، افزونه بارگیری مجدد می شود.

یک شی UI فقط می‌تواند یکی از set Open Link(openLink) ، set On Click Action(action) ، set On Click Open Link Action(action) ، set Authorization Action(action) یا set Compose Action(action, composedEmailType) مجموعه را داشته باشد. .

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

پارامترها

نام	تایپ کنید	توضیحات
action	Authorization Action	شیئی که اقدام مجوزی را که باید هنگام کلیک روی این عنصر انجام شود را مشخص می کند.

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Bottom Label(text)

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

پارامترها

نام	تایپ کنید	توضیحات
text	String	متن برچسب

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Button(button)

Button ای را که در سمت راست متن نمایش داده می شود را تنظیم می کند. یک Decorated Text فقط می تواند یک دکمه یا یک سوئیچ را پشتیبانی کند.

پارامترها

نام	تایپ کنید	توضیحات
button	Button	دکمه اضافه کردن

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Compose Action(action, composedEmailType)

اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد. یک شی UI فقط می‌تواند یکی از set Open Link(openLink) ، set On Click Action(action) ، set On Click Open Link Action(action) ، set Authorization Action(action) یا set Compose Action(action, composedEmailType) مجموعه را داشته باشد. .

پارامتر Action باید تابع فراخوانی را مشخص کند که شیء Compose Action Response پیکربندی شده با استفاده از Compose Action Response Builder.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	شیئی که عمل compose را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.
composed Email Type	Composed Email Type	یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ.

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set End Icon(endIcon)

Icon Image را که در سمت راست محتوا نمایش داده می شود، تنظیم می کند. یک Decorated Text فقط می تواند یک دکمه، یک سوئیچ یا یک نماد را پشتیبانی کند.

پارامترها

نام	تایپ کنید	توضیحات
end Icon	Icon Image	نماد برای اضافه کردن.

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set On Click Action(action)

عملی را تنظیم می کند که با کلیک روی شی اجرا شود. یک شی UI فقط می‌تواند یکی از set Open Link(openLink) ، set On Click Action(action) ، set On Click Open Link Action(action) ، set Authorization Action(action) یا set Compose Action(action, composedEmailType) مجموعه را داشته باشد. .

پارامتر Action باید تابع callback را مشخص کند که یک شی Action Response برمی گرداند.

// ...

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

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set On Click Open Link Action(action)

عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند. از این تابع زمانی استفاده کنید که URL باید ساخته شود یا زمانی که باید اقدامات دیگری را علاوه بر ایجاد شیء Open Link انجام دهید. یک شی UI فقط می‌تواند یکی از set Open Link(openLink) ، set On Click Action(action) ، set On Click Open Link Action(action) ، set Authorization Action(action) یا set Compose Action(action, composedEmailType) مجموعه را داشته باشد. .

پارامتر Action باید یک تابع callback را مشخص کند که یک شی Action Response پیکربندی شده با استفاده از Action Response Builder.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	شیئی که عمل پیوند باز را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Open Link(openLink)

یک URL را تنظیم می کند که با کلیک روی شیء باز شود. از این تابع زمانی استفاده کنید که URL از قبل شناخته شده باشد و فقط باید باز شود. یک شی UI فقط می‌تواند یکی از set Open Link(openLink) ، set On Click Action(action) ، set On Click Open Link Action(action) ، set Authorization Action(action) یا set Compose Action(action, composedEmailType) مجموعه را داشته باشد. .

پارامترها

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

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Start Icon(startIcon)

Icon Image برای نمایش قبل از محتوای متن تنظیم می کند.

پارامترها

نام	تایپ کنید	توضیحات
start Icon	Icon Image	نماد برای نمایش

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Switch Control(switchToSet)

Switch را تنظیم می کند که در سمت راست محتوا نمایش داده می شود. یک Decorated Text فقط می تواند یک دکمه یا یک سوئیچ را پشتیبانی کند.

پارامترها

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

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Text(text)

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

پارامترها

نام	تایپ کنید	توضیحات
text	String	محتوای متنی برای این ویجت.

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Top Label(text)

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

پارامترها

نام	تایپ کنید	توضیحات
text	String	متن برچسب

بازگشت

Decorated Text - این شی، برای زنجیر کردن.

---

set Wrap Text(wrapText)

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

پارامترها

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

بازگشت

Decorated Text - این شی، برای زنجیر کردن.