Class CardAction

CardAction

یک آیتم منوی قابل کلیک که به منوی سرصفحه کارت اضافه می شود.

const action = CardService.newAction();
// Finish building the action...

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

روش ها

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

مستندات دقیق

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

بازگشت

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

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

بازگشت

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

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

بازگشت

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

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

بازگشت

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

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

پارامترها

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

بازگشت

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

setText(text)

متن منو را برای این عمل تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
text String متن آیتم منو

بازگشت

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