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

Class ImageButton

یک ImageButton با یک تصویر نمایش داده شده روی آن.

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

var imageButton = CardService.newImageButton()
    .setAltText("An image button with an airplane icon.")
    .setIcon(CardService.Icon.AIRPLANE)
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://airplane.com"));

مواد و روش ها

روش	نوع برگشت	توضیح مختصر
`setAltText(altText)`	`ImageButton`	متن جایگزین دکمه را برای دسترسی تنظیم می کند.
`setAuthorizationAction(action)`	`ImageButton`	یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند.
`setComposeAction(action, composedEmailType)`	`ImageButton`	اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد.
`setIcon(icon)`	`ImageButton`	یک `Icon` از پیش تعریف شده را برای نمایش روی دکمه تنظیم می کند.
`setIconUrl(url)`	`ImageButton`	URL یک تصویر را برای استفاده به عنوان نماد این دکمه تنظیم می کند.
`setOnClickAction(action)`	`ImageButton`	عملی را تنظیم می کند که با کلیک روی شی اجرا شود.
`setOnClickOpenLinkAction(action)`	`ImageButton`	عملکردی را تنظیم می کند که با کلیک روی شی، URL را در یک برگه باز می کند.
`setOpenLink(openLink)`	`ImageButton`	یک URL را تنظیم می کند که با کلیک روی شیء باز شود.

مستندات دقیق

`setAltText(altText)`

متن جایگزین دکمه را برای دسترسی تنظیم می کند. ضروری.

مولفه های

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

برگشت

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

`setAuthorizationAction(action)`

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

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

// ...

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

مولفه های

نام	تایپ کنید	شرح
`action`	`AuthorizationAction`	شیئی که اقدام مجوزی را که باید هنگام کلیک روی این عنصر انجام شود را مشخص می کند.

برگشت

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

`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 باز می‌شوند.

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

مولفه های

نام	تایپ کنید	شرح
`action`	`Action`	شیئی که عمل compose را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.
`composedEmailType`	`ComposedEmailType`	یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ.

برگشت

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

`setIcon(icon)`

یک Icon از پیش تعریف شده را برای نمایش روی دکمه تنظیم می کند. برای تعریف تصویر دکمه باید از این یا setIconUrl(url) استفاده شود.

مولفه های

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

برگشت

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

`setIconUrl(url)`

URL یک تصویر را برای استفاده به عنوان نماد این دکمه تنظیم می کند. برای تعریف تصویر دکمه باید از این یا setIcon(icon) استفاده شود.

مولفه های

نام	تایپ کنید	شرح
`url`	`String`	آدرس URL یک تصویر میزبانی شده برای استفاده به عنوان نماد این دکمه.

برگشت

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

`setOnClickAction(action)`

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

پارامتر Action باید تابع callback را مشخص کند که یک شی ActionResponse را برمی گرداند.

// ...

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

برگشت

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

`setOnClickOpenLinkAction(action)`

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

پارامتر Action باید تابع callback را مشخص کند که یک شی ActionResponse پیکربندی شده با استفاده از ActionResponseBuilder.setOpenLink(openLink) را برمی گرداند.

// ...

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

برگشت

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

`setOpenLink(openLink)`

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

مولفه های

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

برگشت

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