Виджет, отображающий текст с дополнительными декорациями. Возможные ключи включают значок, метку сверху и метку снизу. Для установки текстового содержимого и одного из ключей необходимо использовать set Text(text) и один из следующих методов: Decorated Text , Decorated Text , set Top Label(text) или set Bottom Label(text) . Этот класс предназначен для замены .Key Value
Доступно для дополнений 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 | Устанавливает, должен ли текст значения отображаться в одной строке или в нескольких строках. |
Подробная документация
add Event Action(eventAction)
Добавляет действие события, которое можно выполнить над виджетом.
Параметры
| Имя | Тип | Описание |
|---|---|---|
event Action | Event Action | Будет добавлено Event Action . |
Возвращаться
Widget — Объект, для объединения в цепочку.
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) .
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Параметры
| Имя | Тип | Описание |
|---|---|---|
action | Authorization Action | Объект, который определяет действие авторизации, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Bottom Label(text)
Устанавливает текст метки, который будет использоваться в качестве ключа и отображаться под текстовым содержимым.
Параметры
| Имя | Тип | Описание |
|---|---|---|
text | String | Текст этикетки. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Button(button)
Устанавливает Button , отображаемую справа от текста. Decorated Text может поддерживать только одну кнопку или один переключатель.
Параметры
| Имя | Тип | Описание |
|---|---|---|
button | Button | Кнопка добавления. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Compose Action(action, composedEmailType)
Задаёт действие, которое создаёт черновик электронного письма при щелчке по объекту. Для объекта пользовательского интерфейса может быть задано только одно из следующих значений: set Open Link(openLink) , set set On Click Action(action) , set On Click Open Link Action(action) , set Authorization Action(action) или set Compose Action(action, composedEmailType) .
Параметр 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 | Значение перечисления, которое определяет, является ли составленный черновик автономным или ответным черновиком. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set End Icon(endIcon)
Задаёт необязательное Icon Image , отображаемое справа от содержимого. Decorated Text может содержать только одну кнопку, один переключатель или один значок.
Параметры
| Имя | Тип | Описание |
|---|---|---|
end Icon | Icon Image | Значок для добавления. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Id(id)
Задаёт уникальный идентификатор, используемый для идентификации виджета, подлежащего мутации. Мутация виджетов поддерживается только в дополнениях.
Параметры
| Имя | Тип | Описание |
|---|---|---|
id | String | Идентификатор виджета длиной не более 64 символов в формате `[a-zA-Z0-9-]+`. |
Возвращаться
Widget — объект для объединения в цепочку.
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) .
Параметр 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 | Действие, которое следует выполнить при щелчке по этому элементу. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
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) .
Параметр 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 | Объект, который определяет действие по открытию ссылки, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Open Link(openLink)
Задаёт 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) .
Параметры
| Имя | Тип | Описание |
|---|---|---|
open Link | Open Link | Объект Open Link , описывающий URL-адрес для открытия. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Start Icon(startIcon)
Устанавливает необязательное Icon Image , отображаемое перед текстовым содержимым.
Параметры
| Имя | Тип | Описание |
|---|---|---|
start Icon | Icon Image | Значок для отображения. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Switch Control(switchToSet)
Устанавливает Switch , отображаемый справа от содержимого. Decorated Text может поддерживать только одну кнопку или один переключатель.
Параметры
| Имя | Тип | Описание |
|---|---|---|
switch To Set | Switch | Переключатель для добавления. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Text(text)
Задаёт текст, который будет использоваться в качестве значения. Поддерживает базовое форматирование HTML . Обязательно.
Параметры
| Имя | Тип | Описание |
|---|---|---|
text | String | Текстовое содержимое этого виджета. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Top Label(text)
Устанавливает текст метки, который будет использоваться в качестве ключа и отображаться над текстовым содержимым.
Параметры
| Имя | Тип | Описание |
|---|---|---|
text | String | Текст этикетки. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.
set Visibility(visibility)
Устанавливает видимость виджета. Значение по умолчанию — `VISIBLE`.
Параметры
| Имя | Тип | Описание |
|---|---|---|
visibility | Visibility | Visibility виджета. |
Возвращаться
Widget — Объект, для объединения в цепочку.
set Wrap Text(wrapText)
Устанавливает, должен ли текст значения отображаться в одной строке или в нескольких строках.
Параметры
| Имя | Тип | Описание |
|---|---|---|
wrap Text | Boolean | Если true , текст переносится и отображается в несколько строк. В противном случае текст обрезается. |
Возвращаться
Decorated Text — этот объект предназначен для объединения в цепочку.