Class Image

تصویر

ویجتی که یک تصویر واحد را نشان می‌دهد. برای اطلاعات بیشتر در مورد برش تصاویر، به Image Crop Style مراجعه کنید.

برای افزونه‌های Google Workspace و برنامه‌های Google Chat در دسترس است.

const image = CardService.newImage()
                  .setAltText('A nice image')
                  .setImageUrl('https://image.png');

روش‌ها

روش نوع بازگشتی شرح مختصر
add Event Action(eventAction) Widget رویدادی را اضافه می‌کند که می‌توان روی ویجت اجرا کرد.
set Alt Text(altText) Image متن جایگزین تصویر را برای دسترسی‌پذیری تنظیم می‌کند.
set Authorization Action(action) Image یک عمل مجوزدهی تنظیم می‌کند که وقتی روی شیء کلیک می‌شود، یک URL به جریان مجوزدهی باز می‌کند.
set Compose Action(action, composedEmailType) Image عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک ایمیل پیش‌نویس ایجاد می‌کند.
set Id(id) Widget شناسه منحصر به فرد اختصاص داده شده برای شناسایی ویجت مورد نظر برای تغییر را تنظیم می‌کند.
set Image Url(url) Image با ارائه URL یا رشته داده، تصویر را برای استفاده تنظیم می‌کند.
set On Click Action(action) Image عملی را تنظیم می‌کند که هنگام کلیک روی شیء اجرا می‌شود.
set On Click Open Link Action(action) Image عملی را تنظیم می‌کند که هنگام کلیک روی شیء، یک URL را در یک برگه باز می‌کند.
set Open Link(openLink) Image یک URL را تنظیم می‌کند که هنگام کلیک روی شیء باز شود.
set Visibility(visibility) Widget میزان نمایش ویجت را تنظیم می‌کند.

مستندات دقیق

add Event Action(eventAction)

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

پارامترها

نام نوع توضیحات
event Action Event Action Event Action قرار است اضافه شود.

بازگشت

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

set Alt Text(altText)

متن جایگزین تصویر را برای دسترسی‌پذیری تنظیم می‌کند. الزامی است.

پارامترها

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

بازگشت

Image — این شیء، برای زنجیر کردن.

set Authorization Action(action)

یک عمل مجوزدهی تنظیم می‌کند که وقتی روی شیء کلیک می‌شود، یک 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);

پارامترها

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

بازگشت

Image — این شیء، برای زنجیر کردن.

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

بازگشت

Image — این شیء، برای زنجیر کردن.

set Id(id)

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

پارامترها

نام نوع توضیحات
id String شناسه‌ی ویجت، با محدودیت ۶۴ کاراکتر و با فرمت `[a-zA-Z0-9-]+`.

بازگشت

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

set Image Url(url)

با ارائه URL یا رشته داده، تصویر را برای استفاده تنظیم می‌کند. الزامی است.

URL ارائه شده می‌تواند یک URL عمومی یا یک رشته تصویر کدگذاری شده base64 باشد. برای به دست آوردن مورد دوم، می‌توانید از کد زیر برای ایجاد یک رشته تصویر کدگذاری شده از یک تصویر در Google Drive خود استفاده کنید، سپس آن رشته را برای استفاده بعدی با set Image Url(url) ذخیره کنید. این روش از نیاز افزونه شما به دسترسی به URL تصویر عمومی جلوگیری می‌کند:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// Image.setImageUrl(url).

پارامترها

نام نوع توضیحات
url String آدرس URL تصویر میزبانی شده برای استفاده، یا یک رشته تصویر کدگذاری شده.

بازگشت

Image — این شیء، برای زنجیر کردن.

set On Click Action(action)

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

پارامترها

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

بازگشت

Image — این شیء، برای زنجیر کردن.

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

بازگشت

Image — این شیء، برای زنجیر کردن.

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

بازگشت

Image — این شیء، برای زنجیر کردن.

set Visibility(visibility)

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

پارامترها

نام نوع توضیحات
visibility Visibility Visibility ویجت.

بازگشت

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