Class TextButton

Текстовая кнопка

Text Button с текстовой меткой. Вы можете установить цвет фона и при необходимости деактивировать кнопку.

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Методы

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

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

set Alt Text(altText)

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

Параметры

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

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

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

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

Text Button — этот объект для цепочки.


set Background Color(backgroundColor)

Устанавливает цвет фона для кнопки Text Button Style.FILLED . Если для кнопки Text Button Style.FILLED не задано значение, кнопка использует дополнительный цвет, определенный в манифесте надстройки. Этот метод не используется для кнопок Text Button Style.OUTLINED .

Параметры

Имя Тип Описание
background Color String Цвет в формате #rgb.

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

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

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

Text Button — этот объект для цепочки.


set Disabled(disabled)

Устанавливает, отключена ли кнопка. Неактивная кнопка отображается серым цветом, и ее нельзя нажать.

Параметры

Имя Тип Описание
disabled Boolean Неактивное состояние.

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

Text Button — этот объект для цепочки.


set Icon(icon)

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

Параметры

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

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

Text Button — этот объект для цепочки.


set Icon Url(url)

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

Параметры

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

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

Text Button — этот объект для цепочки.


set Material Icon(icon)

Устанавливает значок дизайна материала.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Параметры

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

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

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

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

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

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

Text Button — этот объект для цепочки.


Устанавливает 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-адрес.

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

Text 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 Объект, определяющий меню переполнения, отображаемое при щелчке этого элемента.

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

Text Button — этот объект для цепочки.


set Text(text)

Устанавливает текст, который отображается на кнопке.

Параметры

Имя Тип Описание
text String Текст, который появляется на кнопке.

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

Text Button — этот объект для цепочки.


set Text Button Style(textButtonStyle)

Устанавливает стиль кнопки. Если этот параметр не установлен, по умолчанию используется кнопка Text Button Style.OUTLINED .

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Параметры

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

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

Text Button — этот объект для цепочки.