Class TextButton

دکمه متنی

یک TextButton با برچسب متنی. می‌توانید رنگ پس‌زمینه را تنظیم کنید و در صورت نیاز دکمه را غیرفعال کنید.

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

روش‌ها

روش نوع بازگشتی شرح مختصر
set Alt Text(altText) Text Button متن جایگزین دکمه را برای دسترسی‌پذیری تنظیم می‌کند.
set Authorization Action(action) Text Button یک عمل مجوزدهی تنظیم می‌کند که وقتی روی شیء کلیک می‌شود، یک URL به جریان مجوزدهی باز می‌کند.
set Background Color(backgroundColor) Text Button رنگ پس‌زمینه را برای دکمه‌ی Text Button Style.FILLED تنظیم می‌کند.
set Compose Action(action, composedEmailType) Text Button عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک ایمیل پیش‌نویس ایجاد می‌کند.
set Disabled(disabled) Text Button تنظیم می‌کند که آیا دکمه غیرفعال باشد یا خیر.
set Icon(icon) Text Button یک Icon از پیش تعریف شده برای نمایش روی دکمه تنظیم می‌کند.
set Icon Url(url) Text Button آدرس اینترنتی (URL) یک تصویر را برای استفاده به عنوان آیکون این دکمه تنظیم می‌کند.
set Material Icon(icon) Text Button آیکن طراحی متریال را تنظیم می‌کند.
set On Click Action(action) Text Button عملی را تنظیم می‌کند که هنگام کلیک روی شیء اجرا می‌شود.
set On Click Open Link Action(action) Text Button عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک URL را در یک برگه باز می‌کند.
set Open Link(openLink) Text Button یک URL را تنظیم می‌کند که هنگام کلیک روی شیء باز شود.
set Overflow Menu(menu) Text Button یک منوی پاپ‌آپ تنظیم می‌کند که هنگام کلیک روی شیء باز شود.
set Text(text) Text Button متنی که روی دکمه نمایش داده می‌شود را تنظیم می‌کند.
set Text Button Style(textButtonStyle) Text Button سبک دکمه را تنظیم می‌کند.

مستندات دقیق

setAltText(altText)

متن جایگزین دکمه برای دسترسی‌پذیری را تنظیم می‌کند. اگر تنظیم نشده باشد، به طور پیش‌فرض متنی که روی دکمه نمایش داده می‌شود را در نظر می‌گیرد.

پارامترها

نام نوع توضیحات
alt Text String متن جایگزینی که به این دکمه اختصاص داده می‌شود.

بازگشت

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

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

بازگشت

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

setBackgroundColor(backgroundColor)

رنگ پس‌زمینه را برای دکمه‌ی TextButtonStyle.FILLED تنظیم می‌کند. اگر برای دکمه‌ی TextButtonStyle.FILLED تنظیم نشده باشد، دکمه از رنگ ثانویه‌ی تعریف شده در مانیفست افزونه استفاده می‌کند. این متد برای دکمه‌های TextButtonStyle.OUTLINED غیرفعال است.

پارامترها

نام نوع توضیحات
background Color String رنگ با فرمت #rgb.

بازگشت

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

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 یک مقدار شمارشی که مشخص می‌کند آیا پیش‌نویس نوشته شده، یک پیش‌نویس مستقل است یا پاسخی.

بازگشت

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

setDisabled(disabled)

تنظیم می‌کند که آیا دکمه غیرفعال است یا خیر. دکمه غیرفعال خاکستری رنگ است و نمی‌توان روی آن کلیک کرد.

پارامترها

نام نوع توضیحات
disabled Boolean ایالت معلولین.

بازگشت

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

setIcon(icon)

یک Icon از پیش تعریف شده برای نمایش روی دکمه تنظیم می‌کند. برای تعریف تصویر دکمه باید از این یا setIconUrl(url) استفاده شود.

پارامترها

نام نوع توضیحات
icon Icon یکی از مقادیر از پیش تعریف شده Icon .

بازگشت

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

setIconUrl(url)

آدرس اینترنتی (URL) یک تصویر را برای استفاده به عنوان آیکون این دکمه تنظیم می‌کند. برای تعریف تصویر دکمه باید از this یا setIcon(icon) استفاده شود.

پارامترها

نام نوع توضیحات
url String آدرس URL تصویر میزبانی‌شده برای استفاده به عنوان آیکون این دکمه.

بازگشت

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

setMaterialIcon(icon)

آیکن طراحی متریال را تنظیم می‌کند.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

پارامترها

نام نوع توضیحات
icon Material Icon آیکون طراحی متریال.

بازگشت

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

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

بازگشت

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

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

بازگشت

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

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

پارامترها

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

بازگشت

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

setOverflowMenu(menu)

یک منوی پاپ‌آپ تنظیم می‌کند که هنگام کلیک روی شیء باز شود. هر آیتم در منو می‌تواند عملی را که هنگام کلیک اجرا می‌شود، مشخص کند. منوهای تو در تو پشتیبانی نمی‌شوند، اقدامات برای آیتم‌های منو نباید یک منوی سرریز مشخص کنند.

برای برنامه‌های چت گوگل موجود است. در پیش‌نمایش توسعه‌دهندگان برای افزونه‌های Google Workspace.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

پارامترها

نام نوع توضیحات
menu Overflow Menu شیء‌ای که منوی سرریز را برای نمایش هنگام کلیک روی این عنصر مشخص می‌کند.

بازگشت

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

setText(text)

متنی که روی دکمه نمایش داده می‌شود را تنظیم می‌کند.

پارامترها

نام نوع توضیحات
text String متنی که روی دکمه نمایش داده می‌شود.

بازگشت

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

setTextButtonStyle(textButtonStyle)

سبک دکمه را تنظیم می‌کند. اگر تنظیم نشده باشد، به طور پیش‌فرض روی دکمه‌ی TextButtonStyle.OUTLINED تنظیم می‌شود.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

پارامترها

نام نوع توضیحات
text Button Style Text Button Style سبک دکمه.

بازگشت

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