Эта страница переведена с помощью Cloud Translation API.

Class Chip

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

Доступно для приложений Google Chat. В предварительной версии для разработчиков дополнений 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-адрес, который будет открываться при нажатии на объект.

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

`set Alt Text(altText)`

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

Параметры

Имя	Тип	Описание
`alt Text`	`String`	Альтернативный текст, который можно назначить этому чипу.

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

Chip — Этот объект для цепочки.

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

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Параметры

Имя	Тип	Описание
`action`	`Authorization Action`	Объект, определяющий действие авторизации, которое необходимо выполнить при щелчке этого элемента.

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

Chip — Этот объект для цепочки.

`set Compose Action(action, composedEmailType)`

Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. Объект пользовательского интерфейса может иметь только одно из следующих значений: 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) set. .

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

Примечание . Этот метод не устанавливает действие создания , которое используется для расширения пользовательского интерфейса создания . Скорее, этот метод подключает этот элемент пользовательского интерфейса к Action , которое составляет черновики сообщений в скрипте приложений, которые открываются в 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 — Этот объект для цепочки.

`set Disabled(disabled)`

Устанавливает, отключен ли чип. Отключенный чип отображается серым цветом, и на него нельзя нажать.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

Параметры

Имя	Тип	Описание
`disabled`	`Boolean`	Неактивное состояние.

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

Chip — Этот объект для цепочки.

`set Icon(icon)`

Устанавливает значок, который будет использоваться в качестве чипа.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

Параметры

Имя	Тип	Описание
`icon`	`Icon Image`	Одно из предопределенных значений `Icon Image` .

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

Chip — Этот объект для цепочки.

`set Label(label)`

Устанавливает название чипа. Необходимый.

const chip = CardService.newChip().setLabel('bug Report');

Параметры

Имя	Тип	Описание
`label`	`String`	Текст для отображения.

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

Chip — Этот объект для цепочки.

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

Параметр 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`	Действие, которое необходимо выполнить при щелчке по этому элементу.

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

Chip — Этот объект для цепочки.

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

Параметр 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`	Объект, определяющий действие открытия ссылки, которое необходимо выполнить при щелчке по этому элементу.

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

Chip — Этот объект для цепочки.

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

Параметры

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

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

Chip — Этот объект для цепочки.