Class OverflowMenuItem

ПереполнениеМенюПункт

OverflowMenuItem с иконкой и текстовой меткой. При необходимости этот пункт меню можно отключить.

Доступно для приложений 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'));

Методы

Метод Тип возвращаемого значения Краткое описание
set Authorization Action(action) Overflow Menu Item Задает действие авторизации, которое открывает URL-адрес для процесса авторизации при щелчке по объекту.
set Compose Action(action, composedEmailType) Overflow Menu Item Задает действие, которое создает черновик электронного письма при щелчке по объекту.
set Disabled(disabled) Overflow Menu Item Определяет, отключен ли пункт меню.
set On Click Action(action) Overflow Menu Item Задает действие, которое выполняется при щелчке по объекту.
set On Click Open Link Action(action) Overflow Menu Item Задает действие, которое открывает URL-адрес во вкладке при щелчке по объекту.
set Open Link(openLink) Overflow Menu Item Задает URL-адрес, который будет открыт при щелчке по объекту.
set Start Icon(icon) Overflow Menu Item Устанавливает верхнюю иконку пункта меню.
set Text(text) Overflow Menu Item Задает заголовок пункта меню.

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

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

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

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

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 Значение перечисления, указывающее, является ли составленный черновик самостоятельным или ответным.

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

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

setDisabled(disabled)

Определяет, отключен ли пункт меню. Отключенный пункт отображается серым цветом и недоступен для нажатия.

Параметры

Имя Тип Описание
disabled Boolean Состояние инвалидности.

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

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

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 Действие, которое необходимо выполнить при нажатии на этот элемент.

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

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

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

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

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

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

Параметры

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

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

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

setStartIcon(icon)

Устанавливает верхнюю иконку пункта меню.

Параметры

Имя Тип Описание
icon Icon Image Значок для отображения.

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

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

setText(text)

Задает заголовок пункта меню. Обязательно.

Параметры

Имя Тип Описание
text String Текст для отображения.

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

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