Class Chip

Чип

Chip с иконкой и текстовой надписью. При необходимости чип можно деактивировать.

Доступно для приложений Google Chat. Для дополнений Google Workspace доступна предварительная версия для разработчиков.

Предварительная версия для разработчиков: доступна в рамках программы предварительного просмотра Google Workspace для разработчиков , которая предоставляет ранний доступ к определенным функциям.

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

Методы

Метод	Тип возвращаемого значения	Краткое описание
set Alt Text(altText)	Chip	Задает альтернативный текст на чипе для обеспечения доступности.
set Authorization Action(action)	Chip	Задает действие авторизации, которое открывает URL-адрес для процесса авторизации при щелчке по объекту.
set Compose Action(action, composedEmailType)	Chip	Задает действие, которое создает черновик электронного письма при щелчке по объекту.
set Disabled(disabled)	Chip	Определяет, отключен ли чип.
set Icon(icon)	Chip	Задает значок, который будет использоваться в качестве значка чипа.
set Label(label)	Chip	Задает название чипа.
set On Click Action(action)	Chip	Задает действие, которое выполняется при щелчке по объекту.
set On Click Open Link Action(action)	Chip	Задает действие, которое открывает URL-адрес во вкладке при щелчке по объекту.
set Open Link(openLink)	Chip	Задает URL-адрес, который будет открыт при щелчке по объекту.

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

setAltText(altText)

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

Параметры

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

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

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

---

setComposeAction(action, composedEmailType)

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

Параметр Action должен указывать функцию обратного вызова, которая возвращает объект ComposeActionResponse , настроенный с помощью ComposeActionResponseBuilder.setGmailDraft(draft) .

Примечание : Этот метод не задает действие создания сообщения , используемое для расширения пользовательского интерфейса создания сообщений . Вместо этого, этот метод связывает этот элемент пользовательского интерфейса с Action , которое создает черновики сообщений в Apps Script, открываемые в Gmail после завершения действия.

// ...

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	Значение перечисления, указывающее, является ли составленный черновик самостоятельным или ответным.

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

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	Icon Image	Одно из предопределенных значений Icon Image .

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

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) .

Параметры

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

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

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