Class Chip

تراشه

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

برای برنامه‌های چت Google در دسترس است. در پیش‌نمایش برنامه‌نویس برای افزونه‌های 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 را تنظیم می کند که با کلیک روی شیء باز شود.

مستندات دقیق

set Alt Text(altText)

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

پارامترها

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

بازگشت

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

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

بازگشت

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

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

بازگشت

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

set Disabled(disabled)

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

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

پارامترها

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

بازگشت

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

set Icon(icon)

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

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

پارامترها

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

بازگشت

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

set Label(label)

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

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

پارامترها

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

بازگشت

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

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

بازگشت

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

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

بازگشت

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

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

بازگشت

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