Chip
со значком и текстовой меткой. При необходимости вы можете деактивировать чип.
Доступно только для приложений Google Chat. Недоступно для дополнений Google Workspace.
const chip = CardService.newChip() .setLabel('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAltText(altText) | Chip | Устанавливает альтернативный текст чипа для доступности. |
setAuthorizationAction(action) | Chip | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setComposeAction(action, composedEmailType) | Chip | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setDisabled(disabled) | Chip | Устанавливает, отключен ли чип. |
setIcon(icon) | Chip | Устанавливает значок, который будет использоваться в качестве чипа. |
setLabel(label) | Chip | Устанавливает название чипа. |
setOnClickAction(action) | Chip | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | Chip | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | Chip | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
Подробная документация
setAltText(altText)
Устанавливает альтернативный текст чипа для доступности. Если не установлено, по умолчанию используется текст, отображаемый на чипе.
Параметры
Имя | Тип | Описание |
---|---|---|
altText | String | Альтернативный текст, который можно назначить этому чипу. |
Возвращаться
Chip
— Этот объект для цепочки.
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 | AuthorizationAction | Объект, определяющий действие авторизации, которое необходимо выполнить при щелчке этого элемента. |
Возвращаться
Chip
— Этот объект для цепочки.
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() { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Параметры
Имя | Тип | Описание |
---|---|---|
action | Action | Объект, определяющий действие создания, выполняемое при щелчке этого элемента. |
composedEmailType | ComposedEmailType | Значение перечисления, указывающее, является ли составленный черновик автономным или ответным черновиком. |
Возвращаться
Chip
— Этот объект для цепочки.
setDisabled(disabled)
Устанавливает, отключен ли чип. Отключенный чип отображается серым цветом, и на него нельзя нажать.
const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);
Параметры
Имя | Тип | Описание |
---|---|---|
disabled | Boolean | Неактивное состояние. |
Возвращаться
Chip
— Этот объект для цепочки.
setIcon(icon)
Устанавливает значок, который будет использоваться в качестве чипа.
const chip = CardService.newChip().setIcon( CardService.newIconImage().setMaterialIcon( CardService.newMaterialIcon().setName('bug_report'), ), );
Параметры
Имя | Тип | Описание |
---|---|---|
icon | IconImage | Одно из предопределенных значений IconImage . |
Возвращаться
Chip
— Этот объект для цепочки.
setLabel(label)
Устанавливает название чипа. Необходимый.
const chip = CardService.newChip().setLabel('bug Report');
Параметры
Имя | Тип | Описание |
---|---|---|
label | String | Текст для отображения. |
Возвращаться
Chip
— Этот объект для цепочки.
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 | Действие, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
Chip
— Этот объект для цепочки.
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 | Объект, определяющий действие открытия ссылки, которое необходимо выполнить при щелчке по этому элементу. |
Возвращаться
Chip
— Этот объект для цепочки.
setOpenLink(openLink)
Устанавливает URL-адрес, который будет открываться при нажатии на объект. Используйте эту функцию, когда URL-адрес уже известен и его нужно только открыть. Объект пользовательского интерфейса может иметь только один из setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
или setComposeAction(action, composedEmailType)
.
Параметры
Имя | Тип | Описание |
---|---|---|
openLink | OpenLink | Объект OpenLink описывающий открываемый URL-адрес. |
Возвращаться
Chip
— Этот объект для цепочки.