Class TextButton

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

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

var 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 Устанавливает, отключена ли кнопка.
setOnClickAction(action) TextButton Задает действие, которое выполняется при щелчке объекта.
setOnClickOpenLinkAction(action) TextButton Задает действие, которое открывает URL-адрес на вкладке при щелчке объекта.
setOpenLink(openLink) TextButton Устанавливает URL-адрес, который будет открываться при щелчке объекта.
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) .

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Параметры

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

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

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

setBackgroundColor(backgroundColor)

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

Параметры

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

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

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

setComposeAction(action, composedEmailType)

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

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

// ...

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

// ...

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

Параметры

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

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

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

setDisabled(disabled)

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

Параметры

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

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

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

setOnClickAction(action)

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

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект ActionResponse .

// ...

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

// ...

var 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 — этот объект для цепочки.

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

Параметры

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

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

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

setText(text)

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

Параметры

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

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

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

setTextButtonStyle(textButtonStyle)

Устанавливает стиль кнопки. Если не установлено, по умолчанию используется кнопка TextButtonStyle.TEXT .

Параметры

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

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

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