Class DecoratedText

Декорированный текст

Виджет, отображающий текст с дополнительными элементами оформления. Возможные ключи включают иконку, метку сверху и метку снизу. Для установки текстового содержимого и одного из ключей необходимо использовать setText(text) и один из методов DecoratedText , DecoratedText , setTopLabel(text) или setBottomLabel(text) . Этот класс предназначен для замены KeyValue .

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

Методы

Метод Тип возвращаемого значения Краткое описание
add Event Action(eventAction) Widget Добавляет действие события, которое можно выполнить с виджетом.
set Authorization Action(action) Decorated Text Задает действие авторизации, которое открывает URL-адрес для процесса авторизации при щелчке по объекту.
set Bottom Label(text) Decorated Text Задает текст метки, который будет использоваться в качестве ключа и отображаться под текстовым содержимым.
set Button(button) Decorated Text Задает Button , которая отображается справа от текста.
set Compose Action(action, composedEmailType) Decorated Text Задает действие, которое создает черновик электронного письма при щелчке по объекту.
set End Icon(endIcon) Decorated Text Задает необязательное Icon Image , отображаемое справа от содержимого.
set Id(id) Widget Задает уникальный идентификатор, используемый для идентификации виджета, подлежащего изменению.
set On Click Action(action) Decorated Text Задает действие, которое выполняется при щелчке по объекту.
set On Click Open Link Action(action) Decorated Text Задает действие, которое открывает URL-адрес во вкладке при щелчке по объекту.
set Open Link(openLink) Decorated Text Задает URL-адрес, который будет открыт при щелчке по объекту.
set Start Icon(startIcon) Decorated Text Задает необязательное Icon Image , которое будет отображаться перед текстовым содержимым.
set Switch Control(switchToSet) Decorated Text Устанавливает Switch , отображаемый справа от содержимого.
set Text(text) Decorated Text Задает текст, который будет использоваться в качестве значения.
set Top Label(text) Decorated Text Задает текст метки, который будет использоваться в качестве ключа и отображаться над текстовым содержимым.
set Visibility(visibility) Widget Задает видимость виджета.
set Wrap Text(wrapText) Decorated Text Определяет, следует ли отображать текстовое значение в одну или несколько строк.

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

addEventAction(eventAction)

Добавляет действие события, которое можно выполнить с виджетом.

Параметры

Имя Тип Описание
event Action Event Action Необходимо добавить Event Action .

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

Widget — Объект для создания цепочек.

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

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

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

setBottomLabel(text)

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

Параметры

Имя Тип Описание
text String Текст метки.

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

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

setButton(button)

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

Параметры

Имя Тип Описание
button Button Кнопка для добавления.

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

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

setComposeAction(action, composedEmailType)

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

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект ComposeActionResponse , настроенный с помощью ComposeActionResponseBuilder.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 Значение перечисления, указывающее, является ли составленный черновик самостоятельным или ответным.

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

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

setEndIcon(endIcon)

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

Параметры

Имя Тип Описание
end Icon Icon Image Добавить значок.

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

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

setId(id)

Задает уникальный идентификатор, используемый для идентификации виджета, который необходимо изменить. Изменение виджетов поддерживается только в дополнениях.

Параметры

Имя Тип Описание
id String Идентификатор виджета, ограниченный 64 символами и в формате `[a-zA-Z0-9-]+`.

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

setStartIcon(startIcon)

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

Параметры

Имя Тип Описание
start Icon Icon Image Значок для отображения.

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

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

setSwitchControl(switchToSet)

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

Параметры

Имя Тип Описание
switch To Set Switch Добавить переключатель.

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

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

setText(text)

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

Параметры

Имя Тип Описание
text String Текстовое содержимое этого виджета.

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

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

setTopLabel(text)

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

Параметры

Имя Тип Описание
text String Текст метки.

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

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

setVisibility(visibility)

Задает видимость виджета. Значение по умолчанию — `VISIBLE`.

Параметры

Имя Тип Описание
visibility Visibility Visibility виджета.

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

Widget — Объект для создания цепочек.

setWrapText(wrapText)

Определяет, следует ли отображать текстовое значение в одну или несколько строк.

Параметры

Имя Тип Описание
wrap Text Boolean Если true , текст переносится на несколько строк и отображается в один конец. В противном случае текст обрезается.

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

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