Виджет, отображающий текст с дополнительными украшениями. Возможные клавиши включают значок, метку вверху и метку внизу. Требуется установка текстового содержимого и одного из ключей с помощью setText(text)
и одного из DecoratedText
, DecoratedText
, setTopLabel(text)
или setBottomLabel(text)
. Этот класс предназначен для замены
.KeyValue
Доступно для дополнений Google Workspace и приложений Google Chat.
var decoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel"); var multilineDecoratedText = CardService.newDecoratedText() .setText("Text") .setTopLabel("TopLabel") .setWrapText(true) .setBottomLabel("BottomLabel");
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setBottomLabel(text) | DecoratedText | Устанавливает текст метки, который будет использоваться в качестве ключа и отображается под текстовым содержимым. |
setButton(button) | DecoratedText | Устанавливает Button , отображаемую справа от текста. |
setComposeAction(action, composedEmailType) | DecoratedText | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setEndIcon(endIcon) | DecoratedText | Устанавливает необязательный IconImage , который отображается справа от содержимого. |
setOnClickAction(action) | DecoratedText | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | DecoratedText | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | DecoratedText | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
setStartIcon(startIcon) | DecoratedText | Устанавливает необязательный IconImage для отображения перед текстовым содержимым. |
setSwitchControl(switchToSet) | DecoratedText | Устанавливает Switch , который отображается справа от содержимого. |
setText(text) | DecoratedText | Устанавливает текст, который будет использоваться в качестве значения. |
setTopLabel(text) | DecoratedText | Устанавливает текст метки, который будет использоваться в качестве ключа и отображается над текстовым содержимым. |
setWrapText(wrapText) | DecoratedText | Устанавливает, должен ли текст значения отображаться в одной строке или в нескольких строках. |
Подробная документация
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 | Объект, определяющий действие авторизации, которое необходимо выполнить при щелчке этого элемента. |
Возвращаться
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)
.
// ... 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 | Значение перечисления, указывающее, является ли составленный черновик автономным или ответным черновиком. |
Возвращаться
DecoratedText
— этот объект для цепочки.
setEndIcon(endIcon)
Устанавливает необязательный IconImage
, который отображается справа от содержимого. DecoratedText
может поддерживать только одну кнопку, один переключатель или один значок.
Параметры
Имя | Тип | Описание |
---|---|---|
endIcon | IconImage | Значок, который нужно добавить. |
Возвращаться
DecoratedText
— этот объект для цепочки.
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 | Действие, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
DecoratedText
— этот объект для цепочки.
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 | Объект, определяющий действие открытия ссылки, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
DecoratedText
— этот объект для цепочки.
setOpenLink(openLink)
Устанавливает URL-адрес, который будет открываться при нажатии на объект. Используйте эту функцию, когда URL-адрес уже известен и его нужно только открыть. Объект пользовательского интерфейса может иметь только один из setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
или setComposeAction(action, composedEmailType)
.
Параметры
Имя | Тип | Описание |
---|---|---|
openLink | OpenLink | Объект OpenLink , описывающий открываемый URL-адрес. |
Возвращаться
DecoratedText
— этот объект для цепочки.
setStartIcon(startIcon)
Устанавливает необязательный IconImage
для отображения перед текстовым содержимым.
Параметры
Имя | Тип | Описание |
---|---|---|
startIcon | IconImage | Значок для отображения. |
Возвращаться
DecoratedText
— этот объект для цепочки.
setSwitchControl(switchToSet)
Устанавливает Switch
, который отображается справа от содержимого. DecoratedText
может поддерживать только одну кнопку или один переключатель.
Параметры
Имя | Тип | Описание |
---|---|---|
switchToSet | Switch | Переключатель для добавления. |
Возвращаться
DecoratedText
— этот объект для цепочки.
setText(text)
Устанавливает текст, который будет использоваться в качестве значения. Поддерживает базовое форматирование HTML . Необходимый.
Параметры
Имя | Тип | Описание |
---|---|---|
text | String | Текстовое содержимое этого виджета. |
Возвращаться
DecoratedText
— этот объект для цепочки.
setTopLabel(text)
Устанавливает текст метки, который будет использоваться в качестве ключа и отображается над текстовым содержимым.
Параметры
Имя | Тип | Описание |
---|---|---|
text | String | Текст метки. |
Возвращаться
DecoratedText
— этот объект для цепочки.
setWrapText(wrapText)
Устанавливает, должен ли текст значения отображаться в одной строке или в нескольких строках.
Параметры
Имя | Тип | Описание |
---|---|---|
wrapText | Boolean | Если true , текст переносится и отображается в нескольких строках. В противном случае текст будет обрезан. |
Возвращаться
DecoratedText
— этот объект для цепочки.