این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class Chip

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

فقط برای برنامه‌های گپ Google در دسترس است. برای افزونه‌های Google Workspace در دسترس نیست.

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

روش ها

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

مستندات دقیق

`setAltText(altText)`

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

پارامترها

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

بازگشت

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

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

بازگشت

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

`setComposeAction(action, composedEmailType)`

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

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

توجه : این روش یک عملکرد نوشتن را تنظیم نمی کند که برای گسترش رابط کاربری نوشتن استفاده می شود. در عوض، این روش این عنصر رابط کاربری را به یک Action متصل می‌کند که پیام‌های پیش‌نویس را در Apps Script می‌سازد که پس از تکمیل عملکرد در Gmail باز می‌شوند.

// ...

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 را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.
`composedEmailType`	`ComposedEmailType`	یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ.

بازگشت

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`	`IconImage`	یکی از مقادیر از پیش تعریف شده `IconImage` .

بازگشت

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

`setLabel(label)`

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

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

پارامترها

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

بازگشت

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

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

بازگشت

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

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

بازگشت

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

`setOpenLink(openLink)`

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

پارامترها

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

بازگشت

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