Class OverflowMenuItem

OverflowMenuItem

یک OverflowMenuItem با نماد و برچسب متن. در صورت نیاز می توانید آیتم منو را غیرفعال کنید.

فقط برای برنامه‌های گپ 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'));

روش ها

روش نوع برگشت شرح مختصر
setAuthorizationAction(action) OverflowMenuItem یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند.
setComposeAction(action, composedEmailType) OverflowMenuItem اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد.
setDisabled(disabled) OverflowMenuItem تنظیم می کند که آیا آیتم منو غیرفعال باشد.
setOnClickAction(action) OverflowMenuItem عملی را تنظیم می کند که با کلیک روی شی اجرا شود.
setOnClickOpenLinkAction(action) OverflowMenuItem عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند.
setOpenLink(openLink) OverflowMenuItem یک URL را تنظیم می کند که با کلیک روی شیء باز شود.
setStartIcon(icon) OverflowMenuItem نماد اصلی آیتم منو را تنظیم می کند.
setText(text) OverflowMenuItem عنوان آیتم منو را تنظیم می کند.

مستندات دقیق

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

بازگشت

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


setComposeAction(action, composedEmailType)

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

پارامتر Action باید تابع callback را مشخص کند که یک شی ComposeActionResponse پیکربندی شده با استفاده از ComposeActionResponseBuilder.setGmailDraft(draft) را برمی گرداند.

// ...

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

بازگشت

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


setDisabled(disabled)

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

پارامترها

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

بازگشت

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


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

بازگشت

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


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

بازگشت

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


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

پارامترها

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

بازگشت

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


setStartIcon(icon)

نماد اصلی آیتم منو را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
icon IconImage نماد برای نمایش

بازگشت

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


setText(text)

عنوان آیتم منو را تنظیم می کند. مورد نیاز.

پارامترها

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

بازگشت

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