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-адрес откроется в новом окне. Когда пользователь завершает процесс авторизации и возвращается в приложение, надстройка перезагружается.

Объект пользовательского интерфейса может иметь только один из 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)

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

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект ComposeActionResponse , настроенный с помощью ComposeActionResponseBuilder.setGmailDraft(draft) .

// ...

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

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

ImageButton — Этот объект для цепочки.

setIcon(icon)

Устанавливает предопределенный Icon для отображения на кнопке. Либо это, либо setIconUrl(url) необходимо использовать для определения изображения кнопки.

Параметры

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

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

ImageButton — Этот объект для цепочки.

setIconUrl(url)

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

Параметры

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

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

ImageButton — Этот объект для цепочки.

setOnClickAction(action)

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

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект 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 . Объект пользовательского интерфейса может иметь только один из setOpenLink(openLink) , setOnClickAction(action) , setOnClickOpenLinkAction(action) , setAuthorizationAction(action) или setComposeAction(action, composedEmailType) .

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

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

Параметры

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

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

ImageButton — Этот объект для цепочки.