Class Chip

تراشه

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

برای برنامه‌های چت گوگل موجود است. در پیش‌نمایش توسعه‌دهندگان برای افزونه‌های Google Workspace.

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

روش‌ها

روش نوع بازگشتی شرح مختصر
set Alt Text(altText) Chip متن جایگزین تراشه را برای دسترسی‌پذیری تنظیم می‌کند.
set Authorization Action(action) Chip یک عمل مجوزدهی تنظیم می‌کند که وقتی روی شیء کلیک می‌شود، یک URL به جریان مجوزدهی باز می‌کند.
set Compose Action(action, composedEmailType) Chip عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک ایمیل پیش‌نویس ایجاد می‌کند.
set Disabled(disabled) Chip تنظیم می‌کند که آیا تراشه غیرفعال است یا خیر.
set Icon(icon) Chip آیکونی را که قرار است به عنوان تراشه استفاده شود، تنظیم می‌کند.
set Label(label) Chip عنوان تراشه را تنظیم می‌کند.
set On Click Action(action) Chip عملی را تنظیم می‌کند که هنگام کلیک روی شیء اجرا می‌شود.
set On Click Open Link Action(action) Chip عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک URL را در یک برگه باز می‌کند.
set Open Link(openLink) Chip یک URL را تنظیم می‌کند که هنگام کلیک روی شیء باز شود.

مستندات دقیق

setAltText(altText)

متن جایگزین تراشه را برای دسترسی‌پذیری تنظیم می‌کند. اگر تنظیم نشده باشد، به طور پیش‌فرض متنی که روی تراشه نمایش داده می‌شود را در نظر می‌گیرد.

پارامترها

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

بازگشت

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

setAuthorizationAction(action)

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

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

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

پارامترها

نام نوع توضیحات
action Authorization Action شیء‌ای که اقدام مجوزدهی را هنگام کلیک روی این عنصر مشخص می‌کند.

بازگشت

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

setComposeAction(action, composedEmailType)

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

پارامتر Action باید یک تابع فراخوانی را مشخص کند که یک شیء ComposeActionResponse پیکربندی شده با استفاده از ComposeActionResponseBuilder.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 شیء‌ای که مشخص می‌کند هنگام کلیک روی این عنصر، چه عملی برای نوشتن انجام شود.
composed Email Type Composed Email Type یک مقدار شمارشی که مشخص می‌کند آیا پیش‌نویس نوشته شده، یک پیش‌نویس مستقل است یا پاسخی.

بازگشت

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

setDisabled(disabled)

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

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

پارامترها

نام نوع توضیحات
disabled Boolean ایالت معلولین.

بازگشت

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

setIcon(icon)

آیکونی را که قرار است به عنوان تراشه استفاده شود، تنظیم می‌کند.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

پارامترها

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

بازگشت

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

setLabel(label)

عنوان تراشه را تنظیم می‌کند. الزامی است.

const chip = CardService.newChip().setLabel('bug Report');

پارامترها

نام نوع توضیحات
label String متنی که قرار است نمایش داده شود.

بازگشت

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

setOnClickAction(action)

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

پارامتر Action باید یک تابع فراخوانی (callback function) را مشخص کند که یک شیء 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 عملی که هنگام کلیک روی این عنصر انجام می‌شود.

بازگشت

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

setOnClickOpenLinkAction(action)

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

پارامتر Action باید یک تابع فراخوانی را مشخص کند که یک شیء 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 شیء‌ای که مشخص می‌کند هنگام کلیک روی این عنصر، چه عملی برای باز کردن لینک انجام شود.

بازگشت

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

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

پارامترها

نام نوع توضیحات
open Link Open Link یک شیء Open Link که URL مورد نظر برای باز شدن را توصیف می‌کند.

بازگشت

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