Устарело. Этот класс устарел и не должен использоваться в новых сценариях.
Этот класс устарел. Вместо этого используйте DecoratedText
.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAuthorizationAction(action) |
| Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setComposeAction(action, composedEmailType) |
| Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setOnClickAction(action) |
| Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) |
| Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) |
| Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
Устаревшие методы
Метод | Тип возврата | Краткое описание |
---|---|---|
|
| Устанавливает текст метки, который будет использоваться в качестве ключа. |
|
| Устанавливает Button , которая отображается справа от контекста. |
|
| Устанавливает текст, который будет использоваться в качестве значения. |
|
| Устанавливает значок, который будет использоваться в качестве ключа. |
|
| Устанавливает альтернативный текст для значка. |
|
| Устанавливает URL-адрес значка, который будет использоваться в качестве ключа. |
|
| Устанавливает, должен ли текст значения отображаться в одной строке или в нескольких строках. |
|
| Устанавливает Switch , который отображается справа от содержимого. |
|
| Устанавливает текст метки, который будет использоваться в качестве ключа. |
Подробная документация
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 | Объект, определяющий действие авторизации, которое необходимо выполнить при щелчке этого элемента. |
Возвращаться
— этот объект для цепочки. KeyValue
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 | Значение перечисления, указывающее, является ли составленный черновик автономным или черновиком ответа. |
Возвращаться
— этот объект для цепочки. KeyValue
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 | Действие, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
— этот объект для цепочки. KeyValue
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 | Объект, определяющий действие открытия ссылки, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
— этот объект для цепочки. KeyValue
setOpenLink(openLink)
Устанавливает URL-адрес, который будет открываться при нажатии на объект. Используйте эту функцию, когда URL-адрес уже известен и его нужно только открыть. Объект пользовательского интерфейса может иметь только один из setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
или setComposeAction(action, composedEmailType)
.
Параметры
Возвращаться
— этот объект для цепочки.KeyValue
Устаревшие методы
setBottomLabel(text)
setBottomLabel(text)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Устанавливает текст метки, который будет использоваться в качестве ключа. Отображается под текстовым контентом.
Параметры
Имя | Тип | Описание |
---|---|---|
text | String | Текст метки. Примечание. Он не поддерживает базовое форматирование HTML . |
Возвращаться
— этот объект для цепочки. KeyValue
setButton(button)
setButton(button)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Устанавливает Button
, отображаемую справа от контекста.
может поддерживать только одну кнопку, один переключатель или один значок.KeyValue
Параметры
Имя | Тип | Описание |
---|---|---|
button | Button | Кнопка добавления. |
Возвращаться
— этот объект для цепочки. KeyValue
setContent(text)
setContent(text)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Устанавливает текст, который будет использоваться в качестве значения. Поддерживает базовое форматирование HTML . Необходимый.
Параметры
Имя | Тип | Описание |
---|---|---|
text | String | Текстовое содержимое этого виджета. |
Возвращаться
— этот объект для цепочки. KeyValue
setIcon(icon)
setIcon(icon)
setIconAltText(altText)
setIconAltText(altText)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Устанавливает альтернативный текст для значка.
Параметры
Имя | Тип | Описание |
---|---|---|
altText | String | Альтернативный текст для значка. |
Возвращаться
— этот объект для цепочки. KeyValue
setIconUrl(url)
setIconUrl(url)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Устанавливает URL-адрес значка, который будет использоваться в качестве ключа.
Параметры
Имя | Тип | Описание |
---|---|---|
url | String | URL-адрес размещенного изображения, которое будет использоваться в качестве значка. |
Возвращаться
— этот объект для цепочки. KeyValue
setMultiline(multiline)
setMultiline(multiline)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Устанавливает, должен ли текст значения отображаться в одной строке или в нескольких строках.
Параметры
Имя | Тип | Описание |
---|---|---|
multiline | Boolean | Многострочная настройка. |
Возвращаться
— этот объект для цепочки. KeyValue
setSwitch(switchToSet)
setSwitch(switchToSet)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Устанавливает Switch
, который отображается справа от содержимого.
может поддерживать только одну кнопку, один переключатель или один значок.KeyValue
Параметры
Имя | Тип | Описание |
---|---|---|
switchToSet | Switch | Переключатель для добавления. |
Возвращаться
— Этот объект для цепочки. KeyValue
setTopLabel(text)
setTopLabel(text)
Устарело. Эта функция устарела и не должна использоваться в новых скриптах.
Устанавливает текст метки, который будет использоваться в качестве ключа. Отображается над текстовым контентом.
Параметры
Имя | Тип | Описание |
---|---|---|
text | String | Текст метки. Примечание. Он не поддерживает базовое форматирование HTML . |
Возвращаться
— этот объект для цепочки.KeyValue