این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class TextButton

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

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

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

روش ها

روش	نوع برگشت	شرح مختصر
`setAltText(altText)`	`TextButton`	متن جایگزین دکمه را برای دسترسی تنظیم می کند.
`setAuthorizationAction(action)`	`TextButton`	یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند.
`setBackgroundColor(backgroundColor)`	`TextButton`	رنگ پس زمینه را برای دکمه `TextButtonStyle.FILLED` تنظیم می کند.
`setComposeAction(action, composedEmailType)`	`TextButton`	اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد.
`setDisabled(disabled)`	`TextButton`	تنظیم می کند که آیا دکمه غیرفعال باشد.
`setIcon(icon)`	`TextButton`	یک `Icon` از پیش تعریف شده را برای نمایش روی دکمه تنظیم می کند.
`setIconUrl(url)`	`TextButton`	URL یک تصویر را برای استفاده به عنوان نماد این دکمه تنظیم می کند.
`setMaterialIcon(icon)`	`TextButton`	نماد طراحی متریال را تنظیم می کند.
`setOnClickAction(action)`	`TextButton`	عملی را تنظیم می کند که با کلیک روی شی اجرا شود.
`setOnClickOpenLinkAction(action)`	`TextButton`	عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند.
`setOpenLink(openLink)`	`TextButton`	یک URL را تنظیم می کند که با کلیک روی شیء باز شود.
`setOverflowMenu(menu)`	`TextButton`	یک منوی پاپ آپ را تنظیم می کند تا با کلیک روی شیء باز شود.
`setText(text)`	`TextButton`	متنی که روی دکمه نمایش داده می شود را تنظیم می کند.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	سبک دکمه را تنظیم می کند.

مستندات دقیق

`setAltText(altText)`

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

پارامترها

نام	تایپ کنید	توضیحات
`altText`	`String`	متن جایگزین برای اختصاص دادن به این دکمه.

بازگشت

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

`setAuthorizationAction(action)`

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

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

// ...

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

پارامترها

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

بازگشت

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

`setBackgroundColor(backgroundColor)`

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

پارامترها

نام	تایپ کنید	توضیحات
`backgroundColor`	`String`	رنگ با فرمت #rgb.

بازگشت

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

`setComposeAction(action, composedEmailType)`

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

پارامتر Action باید تابع callback را مشخص کند که یک شی ComposeActionResponse پیکربندی شده با استفاده از ComposeActionResponseBuilder.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() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

پارامترها

نام	تایپ کنید	توضیحات
`action`	`Action`	شیئی که عمل compose را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.
`composedEmailType`	`ComposedEmailType`	یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ.

بازگشت

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

`setDisabled(disabled)`

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

پارامترها

نام	تایپ کنید	توضیحات
`disabled`	`Boolean`	حالت معلول

بازگشت

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

`setIcon(icon)`

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

پارامترها

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

بازگشت

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

`setIconUrl(url)`

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

پارامترها

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

بازگشت

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

`setMaterialIcon(icon)`

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

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

پارامترها

نام	تایپ کنید	توضیحات
`icon`	`MaterialIcon`	نماد طراحی متریال

بازگشت

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

`setOnClickAction(action)`

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

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

`setOpenLink(openLink)`

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

پارامترها

نام	تایپ کنید	توضیحات
`openLink`	`OpenLink`	یک شی `OpenLink` که URL مورد نظر را برای باز کردن توصیف می کند.

بازگشت

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

`setOverflowMenu(menu)`

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

فقط برای برنامه‌های گپ Google در دسترس است. برای افزونه‌های 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`	`OverflowMenu`	شیئی که منوی سرریز را مشخص می کند تا با کلیک روی این عنصر نمایش داده شود.

بازگشت

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

پارامترها

نام	تایپ کنید	توضیحات
`textButtonStyle`	`TextButtonStyle`	سبک دکمه.

بازگشت

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