Class TextButton

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

TextButton с текстовой меткой. Вы можете задать цвет фона и отключить кнопку при необходимости.

Доступно для дополнений 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	Задает иконку в стиле Material Design.
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	Задает стиль кнопки.

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

setAltText(altText)

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

Параметры

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

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

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

---

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

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

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

---

setBackgroundColor(backgroundColor)

Устанавливает цвет фона для кнопки TextButtonStyle.FILLED . Если для кнопки TextButtonStyle.FILLED цвет фона не задан, используется дополнительный цвет, определенный в манифесте дополнения. Для кнопок TextButtonStyle.OUTLINED этот метод ничего не делает.

Параметры

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

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

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

---

setComposeAction(action, composedEmailType)

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

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

Примечание : Этот метод не задает действие создания сообщения , используемое для расширения пользовательского интерфейса создания сообщений . Вместо этого, этот метод связывает этот элемент пользовательского интерфейса с Action , которое создает черновики сообщений в Apps Script, открываемые в Gmail после завершения действия.

// ...

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

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

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

---

setDisabled(disabled)

Определяет, отключена ли кнопка. Отключенная кнопка становится неактивной (серой) и недоступна для нажатия.

Параметры

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

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

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

---

setIcon(icon)

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

Параметры

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

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

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

---

setIconUrl(url)

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

Параметры

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

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

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

---

setMaterialIcon(icon)

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

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

Параметры

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

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

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

---

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

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

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

---

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

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

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

---

setOpenLink(openLink)

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

Параметры

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

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

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

---

setOverflowMenu(menu)

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

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

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

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

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

---

setText(text)

Задает текст, отображаемый на кнопке.

Параметры

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

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

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

---

setTextButtonStyle(textButtonStyle)

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

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

Параметры

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

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

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