Class ImageButton

دکمه تصویر

یک Image Button با یک تصویر نمایش داده شده بر روی آن.

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

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

روش ها

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

مستندات دقیق

set Alt Text(altText)

متن جایگزین دکمه را برای دسترسی تنظیم می کند. مورد نیاز.

پارامترها

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

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

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

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

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

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

set Icon(icon)

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

پارامترها

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

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

set Icon Url(url)

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

پارامترها

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

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

set Image Button Style(imageButtonStyle)

سبک دکمه را تنظیم می کند. اگر تنظیم نشود، به طور پیش‌فرض روی دکمه Image Button Style.BORDERLESS تنظیم می‌شود.

فقط برای برنامه‌های گپ Google در دسترس است. برای افزونه‌های Google Workspace در دسترس نیست.

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

پارامترها

نام	تایپ کنید	توضیحات
image Button Style	Image Button Style	سبک دکمه.

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

set Material Icon(icon)

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

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

پارامترها

نام	تایپ کنید	توضیحات
icon	Material Icon	نماد طراحی متریال

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

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

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

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

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

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 مورد نظر را برای باز کردن توصیف می کند.

بازگشت

Image Button - این شی، برای زنجیر کردن.

---

set Overflow Menu(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	Overflow Menu	شیئی که منوی سرریز را مشخص می کند تا با کلیک روی این عنصر نمایش داده شود.

بازگشت

Image Button - این شی، برای زنجیر کردن.