Базовый класс для всех кнопок.
Доступно для дополнений Google Workspace и приложений Google Chat.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
set Authorization Action(action) | Button | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
set Compose Action(action, composedEmailType) | Button | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
set On Click Action(action) | Button | Устанавливает действие, которое выполняется при щелчке объекта. |
set On Click Open Link Action(action) | Button | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
set Open Link(openLink) | Button | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
set Overflow Menu(menu) | Button | Устанавливает всплывающее меню, которое будет открываться при щелчке объекта. |
Подробная документация
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)
set. .
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Параметры
Имя | Тип | Описание |
---|---|---|
action | Authorization Action | Объект, определяющий действие авторизации, которое необходимо выполнить при щелчке этого элемента. |
Возвращаться
Button
— этот объект для цепочки.
set Compose Action(action, composedEmailType)
Устанавливает действие, которое составляет черновик электронного письма при щелчке объекта. Объект пользовательского интерфейса может иметь только одно из следующих значений: 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)
set. .
Параметр 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 | Значение перечисления, указывающее, является ли составленный черновик автономным или ответным черновиком. |
Возвращаться
Button
— этот объект для цепочки.
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)
set. .
Параметр Action
должен указывать функцию обратного вызова, которая возвращает объект 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 | Действие, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
Button
— этот объект для цепочки.
set On Click Open Link Action(action)
Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. Используйте эту функцию, когда URL-адрес необходимо создать или когда вам нужно выполнить другие действия помимо создания объекта Open Link
. Объект пользовательского интерфейса может иметь только одно из следующих значений: 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)
set. .
Параметр 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 | Объект, определяющий действие открытия ссылки, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
Button
— этот объект для цепочки.
set Open Link(openLink)
Устанавливает 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)
set. .
Параметры
Имя | Тип | Описание |
---|---|---|
open Link | Open Link | Объект Open Link описывающий открываемый URL-адрес. |
Возвращаться
Button
— этот объект для цепочки.
set Overflow Menu(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 | Объект, определяющий меню переполнения, отображаемое при щелчке этого элемента. |
Возвращаться
Button
— этот объект для цепочки.