Эта страница переведена с помощью Cloud Translation API.

Class TextButton

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

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

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

Методы

Метод	Тип возврата	Краткое описание
`setAltText(altText)`	`TextButton`	Устанавливает альтернативный текст кнопки для специальных возможностей.
`setAuthorizationAction(action)`	`TextButton`	Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта.
`setBackgroundColor(backgroundColor)`	`TextButton`	Устанавливает цвет фона для кнопки `TextButtonStyle.FILLED` .
`setComposeAction(action, composedEmailType)`	`TextButton`	Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта.
`setDisabled(disabled)`	`TextButton`	Устанавливает, отключена ли кнопка.
`setIcon(icon)`	`TextButton`	Устанавливает предопределенный `Icon` для отображения на кнопке.
`setIconUrl(url)`	`TextButton`	Устанавливает URL-адрес изображения, которое будет использоваться в качестве значка этой кнопки.
`setMaterialIcon(icon)`	`TextButton`	Устанавливает значок дизайна материала.
`setOnClickAction(action)`	`TextButton`	Устанавливает действие, которое выполняется при щелчке объекта.
`setOnClickOpenLinkAction(action)`	`TextButton`	Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта.
`setOpenLink(openLink)`	`TextButton`	Устанавливает URL-адрес, который будет открываться при нажатии на объект.
`setOverflowMenu(menu)`	`TextButton`	Устанавливает всплывающее меню, которое будет открываться при щелчке объекта.
`setText(text)`	`TextButton`	Устанавливает текст, который отображается на кнопке.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	Устанавливает стиль кнопки.

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

`setAltText(altText)`

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

Параметры

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

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

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

`setBackgroundColor(backgroundColor)`

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

Параметры

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

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

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

`setComposeAction(action, composedEmailType)`

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

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

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

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Параметры

Имя	Тип	Описание
`action`	`Action`	Объект, определяющий действие создания, выполняемое при щелчке этого элемента.
`composedEmailType`	`ComposedEmailType`	Значение перечисления, указывающее, является ли составленный черновик автономным или ответным черновиком.

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

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

`setDisabled(disabled)`

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

Параметры

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

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

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

`setIcon(icon)`

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

Параметры

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

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

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

`setIconUrl(url)`

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

Параметры

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

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

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

`setMaterialIcon(icon)`

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

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

Параметры

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

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

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) .

Параметры

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

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

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

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

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

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'));

Параметры

Имя	Тип	Описание
`textButtonStyle`	`TextButtonStyle`	Стиль кнопки.

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

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