Class KeyValue

KeyValue

Устарело. Этот класс устарел и не должен использоваться в новых скриптах.

Этот класс устарел. Вместо него используйте DecoratedText .

Методы

Метод Тип возвращаемого значения Краткое описание
add Event Action(eventAction) Widget Добавляет действие события, которое можно выполнить с виджетом.
set Authorization Action(action) Key Value Задает действие авторизации, которое открывает URL-адрес для процесса авторизации при щелчке по объекту.
set Compose Action(action, composedEmailType) Key Value Задает действие, которое создает черновик электронного письма при щелчке по объекту.
set Id(id) Widget Задает уникальный идентификатор, используемый для идентификации виджета, подлежащего изменению.
set On Click Action(action) Key Value Задает действие, которое выполняется при щелчке по объекту.
set On Click Open Link Action(action) Key Value Задает действие, которое открывает URL-адрес во вкладке при щелчке по объекту.
set Open Link(openLink) Key Value Задает URL-адрес, который будет открыт при щелчке по объекту.
set Visibility(visibility) Widget Задает видимость виджета.

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

addEventAction(eventAction)

Добавляет действие события, которое можно выполнить с виджетом.

Параметры

Имя Тип Описание
event Action Event Action Необходимо добавить Event Action .

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

Widget — Объект для создания цепочек.

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

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

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

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

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

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

setId(id)

Задает уникальный идентификатор, используемый для идентификации виджета, который необходимо изменить. Изменение виджетов поддерживается только в дополнениях.

Параметры

Имя Тип Описание
id String Идентификатор виджета, ограниченный 64 символами и в формате `[a-zA-Z0-9-]+`.

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

Widget — этот объект используется для создания цепочек вызовов.

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

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

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

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

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

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

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

Параметры

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

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

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

setVisibility(visibility)

Задает видимость виджета. Значение по умолчанию — `VISIBLE`.

Параметры

Имя Тип Описание
visibility Visibility Visibility виджета.

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

Widget — Объект для создания цепочек.

Устаревшие методы