Class KeyValue

رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.

پارامترها

بازگشت

Widget — شیء، برای زنجیره‌سازی.

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

یک شیء رابط کاربری فقط می‌تواند یکی از 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);

پارامترها

بازگشت

Key Value — این شیء، برای زنجیره‌سازی.

عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک ایمیل پیش‌نویس ایجاد می‌کند. یک شیء 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();
}

پارامترها

بازگشت

Key Value — این شیء، برای زنجیره‌سازی.

شناسه منحصر به فردی که برای شناسایی ویجت مورد نظر برای تغییر استفاده می‌شود را تنظیم می‌کند. تغییر ویجت فقط در افزونه‌ها پشتیبانی می‌شود.

پارامترها

بازگشت

Widget - این شیء، برای زنجیره‌سازی.

عملی را تنظیم می‌کند که هنگام کلیک روی شیء اجرا می‌شود. یک شیء رابط کاربری فقط می‌تواند یکی از 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 function) را مشخص کند که یک شیء 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();
}

پارامترها

بازگشت

Key Value — این شیء، برای زنجیره‌سازی.

عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک 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 باید یک تابع فراخوانی را مشخص کند که یک شیء 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();
}

پارامترها

بازگشت

Key Value — این شیء، برای زنجیره‌سازی.

یک 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) را داشته باشد.

پارامترها

بازگشت

Key Value — این شیء، برای زنجیره‌سازی.

میزان نمایش ویجت را تنظیم می‌کند. مقدار پیش‌فرض آن `VISIBLE` است.

پارامترها

بازگشت

Widget — شیء، برای زنجیره‌سازی.