Class Button

دکمه

یک کلاس پایه برای همه دکمه ها.

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

روش ها

روش نوع برگشت شرح مختصر
set Authorization Action(action) Button یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند.
set Compose Action(action, composedEmailType) Button اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد.
set On Click Action(action) Button عملی را تنظیم می کند که با کلیک روی شی اجرا شود.
set On Click Open Link Action(action) Button عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند.
set Open Link(openLink) Button یک URL را تنظیم می کند که با کلیک روی شیء باز شود.
set Overflow Menu(menu) 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 شیئی که اقدام مجوزی را که باید هنگام کلیک روی این عنصر انجام شود را مشخص می کند.

بازگشت

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) را برمی گرداند.

// ...

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

بازگشت

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

بازگشت

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

بازگشت

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

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

بازگشت

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

بازگشت

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