Class ImageButton

ImageButton

ImageButton с отображаемым изображением.

Доступно для дополнений Google Workspace и приложений Google Chat.

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

Методы

Метод Тип возвращаемого значения Краткое описание
set Alt Text(altText) Image Button Задает альтернативный текст кнопки для обеспечения доступности.
set Authorization Action(action) Image Button Задает действие авторизации, которое открывает URL-адрес для процесса авторизации при щелчке по объекту.
set Compose Action(action, composedEmailType) Image Button Задает действие, которое создает черновик электронного письма при щелчке по объекту.
set Icon(icon) Image Button Задает предопределенный Icon для отображения на кнопке.
set Icon Url(url) Image Button Задает URL-адрес изображения, которое будет использоваться в качестве значка этой кнопки.
set Image Button Style(imageButtonStyle) Image Button Задает стиль кнопки.
set Material Icon(icon) Image Button Задает иконку в стиле Material Design.
set On Click Action(action) Image Button Задает действие, которое выполняется при щелчке по объекту.
set On Click Open Link Action(action) Image Button Задает действие, которое открывает URL-адрес во вкладке при щелчке по объекту.
set Open Link(openLink) Image Button Задает URL-адрес, который будет открыт при щелчке по объекту.
set Overflow Menu(menu) Image Button Задает всплывающее меню, которое будет открываться при щелчке по объекту.

Подробная документация

setAltText(altText)

Задает альтернативный текст кнопки для обеспечения доступности. Обязательный параметр.

Параметры

Имя Тип Описание
alt Text String Альтернативный текст для присвоения этой кнопке.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

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 Объект, определяющий действие авторизации, которое должно быть выполнено при нажатии на этот элемент.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

setComposeAction(action, composedEmailType)

Задает действие, которое создает черновик электронного письма при щелчке по объекту. Объект пользовательского интерфейса может иметь только одно из следующих заданий: 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 Значение перечисления, указывающее, является ли составленный черновик самостоятельным или ответным.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

setIcon(icon)

Задает предопределенную Icon для отображения на кнопке. Для определения изображения кнопки необходимо использовать либо this, либо setIconUrl(url) .

Параметры

Имя Тип Описание
icon Icon Одно из предопределенных значений Icon .

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

setIconUrl(url)

Задает URL-адрес изображения, которое будет использоваться в качестве значка этой кнопки. Для определения изображения кнопки необходимо использовать либо this, либо setIcon(icon) .

Параметры

Имя Тип Описание
url String URL-адрес размещенного изображения, которое будет использоваться в качестве значка этой кнопки.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

setImageButtonStyle(imageButtonStyle)

Задает стиль кнопки. Если не задано, по умолчанию используется стиль кнопки ImageButtonStyle.BORDERLESS .

Доступно для приложений Google Chat. Для дополнений Google Workspace доступна предварительная версия для разработчиков.

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

Параметры

Имя Тип Описание
image Button Style Image Button Style Стиль кнопок.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

setMaterialIcon(icon)

Задает иконку в стиле Material Design.

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Параметры

Имя Тип Описание
icon Material Icon Иконка материального дизайна.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

setOnClickAction(action)

Задает действие, которое выполняется при щелчке по объекту. Для объекта пользовательского интерфейса может быть установлено только одно из следующих действий setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект 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 Действие, которое необходимо выполнить при нажатии на этот элемент.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

setOnClickOpenLinkAction(action)

Задает действие, которое открывает URL-адрес во вкладке при щелчке по объекту. Используйте эту функцию, когда необходимо создать URL-адрес или выполнить другие действия в дополнение к созданию объекта OpenLink . Объект пользовательского интерфейса может иметь только одно из следующих заданий: 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 Объект, определяющий действие по открытию ссылки при щелчке по этому элементу.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

Устанавливает URL-адрес, который будет открыт при щелчке по объекту. Используйте эту функцию, когда URL-адрес уже известен и его нужно только открыть. Объект пользовательского интерфейса может иметь только один из следующих параметров: setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

Параметры

Имя Тип Описание
open Link Open Link Объект Open Link , описывающий URL-адрес для открытия.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.

setOverflowMenu(menu)

Задает всплывающее меню, которое открывается при щелчке по объекту. Каждый пункт меню может указывать действие, которое будет выполняться при щелчке. Вложенные меню не поддерживаются, действия для пунктов меню не должны указывать на переполнение меню.

Доступно для приложений Google Chat. Для дополнений Google Workspace доступна предварительная версия для разработчиков.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Параметры

Имя Тип Описание
menu Overflow Menu Объект, определяющий меню переполнения, которое отображается при щелчке по этому элементу.

Возвращаться

ImageButton — Этот объект используется для создания цепочек вызовов.