Этот сервис позволяет сценариям настраивать и создавать компоненты карточек и виджетов, а также их поведение для пользовательского интерфейса. Структуры пользовательского интерфейса, которые вы создаете с помощью этого сервиса, автоматически доступны как на настольных, так и на мобильных устройствах, поэтому вам не нужно разрабатывать отдельные пользовательские интерфейсы для обоих.
Классы
Имя | Краткое описание |
---|---|
Action | Действие, которое обеспечивает интерактивность элементов пользовательского интерфейса. |
ActionResponse | Объект ответа, который может быть возвращен функцией обратного вызова (например, обработчиком ответа формы) для выполнения одного или нескольких действий с клиентом. |
ActionResponseBuilder | Построитель объектов ActionResponse . |
Attachment | Представляет вложение, созданное надстройкой. |
AuthorizationAction | Действие авторизации, которое при нажатии отправляет пользователя на AuthorizationUrl. |
AuthorizationException | Ошибка, которая может быть возвращена, чтобы инициировать показ карты авторизации пользователю. |
BorderStyle | Класс, представляющий полный стиль границы, который можно применять к виджетам. |
BorderType | Перечисление, представляющее типы границ, которые можно применять к виджетам. |
Button | Базовый класс для всех кнопок. |
ButtonSet | Содержит набор объектов Button , отображаемых подряд. |
CalendarEventActionResponse | Представляет ответ, который вносит изменения в событие календаря, которое в данный момент редактирует пользователь, в ответ на действие, выполненное в пользовательском интерфейсе, например нажатие кнопки. |
CalendarEventActionResponseBuilder | Построитель объектов CalendarEventActionResponse . |
Card | Карточка контекста, представляющая одно представление в пользовательском интерфейсе. |
CardAction | Кликабельный пункт меню, который добавляется в меню заголовка карточки. |
CardBuilder | Конструктор объектов Card . |
CardHeader | Заголовок Card . |
CardSection | Раздел карточки содержит группы виджетов и обеспечивает визуальное разделение между ними. |
CardService | CardService предоставляет возможность создавать общие карты, используемые в различных продуктах расширения Google, таких как надстройки Google Workspace . |
ComposeActionResponse | Объект ответа, который может быть возвращен методом обратного вызова для действия создания сообщения в надстройке Gmail . |
ComposeActionResponseBuilder | Построитель объектов ComposeActionResponse . |
ComposedEmailType | Значение перечисления, указывающее, является ли составленное электронное письмо отдельным или черновиком ответа. |
ContentType | Значение перечисления, указывающее тип контента, созданного UpdateDraftActionResponse . |
DatePicker | Поле ввода, позволяющее ввести дату. |
DateTimePicker | Поле ввода, позволяющее пользователям вводить дату и время. |
DecoratedText | Виджет, отображающий текст с дополнительными украшениями. |
DisplayStyle | Перечисление, определяющее стиль отображения карточки. |
Divider | Горизонтальный разделитель. |
DriveItemsSelectedActionResponse | Представляет ответ, который вносит изменения в Диск при выборе элементов Диска и в ответ на действие, выполненное в пользовательском интерфейсе, например нажатие кнопки. |
DriveItemsSelectedActionResponseBuilder | Построитель объектов DriveItemsSelectedActionResponse . |
EditorFileScopeActionResponse | Вносит изменения в редактор, например в Документы Google, Таблицы или Слайды, в ответ на действие, выполненное в пользовательском интерфейсе. |
EditorFileScopeActionResponseBuilder | Построитель объектов EditorFileScopeActionResponse . |
FixedFooter | Фиксированный нижний колонтитул, отображаемый в нижней части дополнительной Card . |
Grid | Организованная сетка для отображения коллекции элементов сетки. |
GridItem | Элементы, с которыми пользователи взаимодействуют в виджете сетки. |
GridItemLayout | Перечисление, определяющее стиль изображения и текста GridItem. |
HorizontalAlignment | Перечисление, определяющее горизонтальное выравнивание виджета. |
Icon | Предопределенные значки, которые можно использовать в различных объектах пользовательского интерфейса, таких как виджеты ImageButton или DecoratedText . |
IconImage | Предопределенный значок или значок из URL-адреса с настраиваемым стилем обрезки. |
Image | Виджет, который показывает одно изображение. |
ImageButton | ImageButton с отображаемым на нем изображением. |
ImageComponent | Компонент изображения, который можно добавить к элементам сетки. |
ImageCropStyle | Класс, представляющий стиль обрезки, который можно применять к компонентам изображения. |
ImageCropType | Перечисление, представляющее стили обрезки, примененные к компонентам изображения. |
ImageStyle | Перечисление, определяющее стиль обрезки изображения. |
| Этот класс устарел. |
LoadIndicator | Тип перечисления, указывающий тип загрузки или индикатор хода выполнения, который будет отображаться во время обработки Action . |
Navigation | Вспомогательный объект, управляющий навигацией по карточкам. |
Notification | Уведомление, отображаемое пользователю как ответ на взаимодействие с элементом пользовательского интерфейса. |
OnClose | Перечисление, указывающее, что делать, когда URL-адрес, открытый через OpenLink , закрывается. |
OpenAs | Перечисление, указывающее, как открыть URL-адрес. |
OpenLink | Представляет действие по открытию ссылки с некоторыми параметрами. |
SelectionInput | Поле ввода, позволяющее выбирать между набором предопределенных параметров. |
SelectionInputType | Тип ввода выбора. |
Suggestions | Предложения автозаполнения для дополнения виджета TextInput . |
SuggestionsResponse | Объект ответа, который может быть возвращен функцией обратного вызова предложений. |
SuggestionsResponseBuilder | Построитель объектов SuggestionsResponse . |
Switch | Элемент пользовательского интерфейса, который поддерживает включение и выключение. |
SwitchControlType | Тип элемента управления виджетом Switch . |
TextButton | TextButton с текстовой меткой. |
TextButtonStyle | Перечисление, определяющее стиль TextButton . |
TextInput | Виджет поля ввода, который принимает ввод текста. |
TextParagraph | Виджет, отображающий текст и поддерживающий базовое форматирование HTML . |
TimePicker | Поле ввода, позволяющее пользователям вводить время. |
UniversalActionResponse | Объект ответа, который может быть возвращен методом, создающим универсальное действие. |
UniversalActionResponseBuilder | Построитель объектов UniversalActionResponse . |
UpdateDraftActionResponse | Представляет действие, которое обновляет черновик электронного письма, который в данный момент редактирует пользователь. |
UpdateDraftActionResponseBuilder | Построитель объектов UpdateDraftActionResponse . |
UpdateDraftBccRecipientsAction | Обновляет получателей скрытой копии черновика электронного письма. |
UpdateDraftBodyAction | Обновляет черновик сообщения электронной почты. |
UpdateDraftBodyType | Значение перечисления, указывающее тип UpdateDraftBodyAction . |
UpdateDraftCcRecipientsAction | Обновляет получателей копии черновика электронного письма. |
UpdateDraftSubjectAction | Обновляет тему черновика электронного письма. |
UpdateDraftToRecipientsAction | Обновляет поле «Получателям» черновика электронного письма. |
Widget | Базовый класс для всех виджетов, которые можно добавить на Card . |
Action
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setFunctionName(functionName) | Action | Устанавливает имя вызываемой функции обратного вызова. |
setLoadIndicator(loadIndicator) | Action | Устанавливает индикатор загрузки, который отображается во время выполнения действия. |
setParameters(parameters) | Action | Позволяет передавать пользовательские параметры в функцию обратного вызова. |
ActionResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
ActionResponseBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | ActionResponse | Создает текущий ответ действия и проверяет его. |
setNavigation(navigation) | ActionResponseBuilder | Устанавливает ответ на действие Navigation . |
setNotification(notification) | ActionResponseBuilder | Устанавливает отображение уведомления при активации действия. |
setOpenLink(openLink) | ActionResponseBuilder | Устанавливает URL-адрес для перехода при активации действия. |
setStateChanged(stateChanged) | ActionResponseBuilder | Устанавливает флаг, указывающий, что это действие изменило существующее состояние данных. |
Attachment
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setIconUrl(iconUrl) | Attachment | Устанавливает URL-адрес значка для вложения. |
setMimeType(mimeType) | Attachment | Устанавливает тип MIME для вложения. |
setResourceUrl(resourceUrl) | Attachment | Устанавливает URL-адрес ресурса для вложения. |
setTitle(title) | Attachment | Устанавливает заголовок вложения. |
AuthorizationAction
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAuthorizationUrl(authorizationUrl) | AuthorizationAction | Устанавливает URL-адрес авторизации, по которому пользователь перенаправляется из запроса на авторизацию. |
AuthorizationException
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
setAuthorizationUrl(authUrl) | AuthorizationException | Устанавливает URL-адрес авторизации, по которому пользователь перенаправляется из запроса на авторизацию. |
setCustomUiCallback(callback) | AuthorizationException | Имя функции, которую необходимо вызвать для создания пользовательского запроса авторизации. |
setResourceDisplayName(name) | AuthorizationException | Устанавливает имя, которое будет отображаться пользователю при запросе авторизации. |
throwException() | void | Запускает создание этого исключения. |
BorderStyle
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setCornerRadius(radius) | BorderStyle | Устанавливает угловой радиус границы, например 8. |
setStrokeColor(color) | BorderStyle | Устанавливает цвет границы. |
setType(type) | BorderStyle | Устанавливает тип границы. |
BorderType
Характеристики
Свойство | Тип | Описание |
---|---|---|
NO_BORDER | Enum | Нет стиля границы. |
STROKE | Enum | Стиль границы обводки. |
Button
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAuthorizationAction(action) | Button | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setComposeAction(action, composedEmailType) | Button | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setOnClickAction(action) | Button | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | Button | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | Button | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
ButtonSet
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addButton(button) | ButtonSet | Добавляет кнопку. |
CalendarEventActionResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
CalendarEventActionResponseBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addAttachments(attachments) | CalendarEventActionResponseBuilder | Указывает, что ответ должен добавлять вложения к событию календаря при выполнении соответствующего действия пользовательского интерфейса. |
addAttendees(emails) | CalendarEventActionResponseBuilder | Указывает, что ответ должен добавлять указанных участников к событию календаря при выполнении соответствующего действия пользовательского интерфейса. |
build() | CalendarEventActionResponse | Создает текущий ответ действия на событие календаря и проверяет его. |
setConferenceData(conferenceData) | CalendarEventActionResponseBuilder | Указывает, что ответ должен установить указанные данные конференции в событие календаря при выполнении соответствующего действия пользовательского интерфейса. |
Card
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
CardAction
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAuthorizationAction(action) | CardAction | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setComposeAction(action, composedEmailType) | CardAction | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setOnClickAction(action) | CardAction | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | CardAction | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | CardAction | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
setText(text) | CardAction | Устанавливает текст меню для этого действия. |
CardBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addCardAction(cardAction) | CardBuilder | Добавляет CardAction к этой карточке. |
addSection(section) | CardBuilder | Добавляет раздел к этой карточке. |
build() | Card | Создает текущую карту и проверяет ее. |
setDisplayStyle(displayStyle) | CardBuilder | Устанавливает стиль отображения для этой карточки. |
setFixedFooter(fixedFooter) | CardBuilder | Устанавливает фиксированный нижний колонтитул для этой карточки. |
setHeader(cardHeader) | CardBuilder | Устанавливает заголовок для этой карты. |
setName(name) | CardBuilder | Устанавливает имя для этой карты. |
setPeekCardHeader(peekCardHeader) | CardBuilder | Устанавливает заголовок карты просмотра. |
CardHeader
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setImageAltText(imageAltText) | CardHeader | Устанавливает альтернативный текст для изображения заголовка. |
setImageStyle(imageStyle) | CardHeader | Устанавливает обрезку значка в заголовке карточки. |
setImageUrl(imageUrl) | CardHeader | Устанавливает изображение для использования в заголовке, предоставляя его URL-адрес или строку данных. |
setSubtitle(subtitle) | CardHeader | Устанавливает подзаголовок заголовка карточки. |
setTitle(title) | CardHeader | Устанавливает заголовок заголовка карточки. |
CardSection
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addWidget(widget) | CardSection | Добавляет данный виджет в этот раздел. |
setCollapsible(collapsible) | CardSection | Устанавливает, можно ли свернуть раздел. |
setHeader(header) | CardSection | Устанавливает заголовок раздела. |
setNumUncollapsibleWidgets(numUncollapsibleWidgets) | CardSection | Устанавливает количество виджетов, которые все еще отображаются, когда этот раздел свернут. |
CardService
Характеристики
Свойство | Тип | Описание |
---|---|---|
BorderType | BorderType | Перечисление BorderType . |
ComposedEmailType | ComposedEmailType | Перечисление ComposedEmailType . |
ContentType | ContentType | Перечисление ContentType . |
GridItemLayout | GridItemLayout | Перечисление GridItemLayout . |
HorizontalAlignment | HorizontalAlignment | Перечисление HorizontalAlignment . |
Icon | Icon | Перечисление Icon . |
ImageCropType | ImageCropType | Перечисление ImageCropType . |
ImageStyle | ImageStyle | Перечисление ImageStyle . |
LoadIndicator | LoadIndicator | Перечисление LoadIndicator . |
OnClose | OnClose | Перечисление OnClose . |
OpenAs | OpenAs | Перечисление OpenAs . |
SelectionInputType | SelectionInputType | Перечисление SelectionInputType . |
TextButtonStyle | TextButtonStyle | Перечисление TextButtonStyle . |
UpdateDraftBodyType | UpdateDraftBodyType | Перечисление UpdateDraftBodyType . |
Методы
ComposeActionResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
ComposeActionResponseBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | ComposeActionResponse | Создает текущий ответ действия создания и проверяет его. |
setGmailDraft(draft) | ComposeActionResponseBuilder | Устанавливает черновик GmailMessage , созданный с помощью GmailMessage.createDraftReply(body) или аналогичных функций. |
ComposedEmailType
Характеристики
Свойство | Тип | Описание |
---|---|---|
REPLY_AS_DRAFT | Enum | Черновик, являющийся ответом на другое сообщение. |
STANDALONE_DRAFT | Enum | Черновик, представляющий собой отдельное сообщение. |
ContentType
Характеристики
Свойство | Тип | Описание |
---|---|---|
TEXT | Enum | Указывает, что сгенерированное содержимое представляет собой обычный текст. |
MUTABLE_HTML | Enum | Указывает, что созданное содержимое отформатировано как HTML. |
IMMUTABLE_HTML | Enum | Указывает, что созданное содержимое отформатировано как HTML, но после создания это содержимое нельзя редактировать. |
DatePicker
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setFieldName(fieldName) | DatePicker | Задает имя поля, которое идентифицирует это средство выбора в объекте события, который создается при взаимодействии пользовательского интерфейса. |
setOnChangeAction(action) | DatePicker | Устанавливает Action , которое скрипт выполняет при каждом изменении входных данных средства выбора. |
setTitle(title) | DatePicker | Устанавливает заголовок, отображаемый над полем ввода. |
setValueInMsSinceEpoch(valueMsEpoch) | DatePicker | Устанавливает предварительно заполненное значение, которое будет установлено в поле ввода. |
setValueInMsSinceEpoch(valueMsEpoch) | DatePicker | Устанавливает предварительно заполненное значение, которое будет установлено в поле ввода. |
DateTimePicker
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setFieldName(fieldName) | DateTimePicker | Задает имя поля, которое идентифицирует это средство выбора в объекте события, который создается при взаимодействии пользовательского интерфейса. |
setOnChangeAction(action) | DateTimePicker | Устанавливает Action , которое скрипт выполняет при каждом изменении входных данных средства выбора. |
setTimeZoneOffsetInMins(timeZoneOffsetMins) | DateTimePicker | Устанавливает количество минут, на которое часовой пояс должен быть смещен от UTC. |
setTitle(title) | DateTimePicker | Устанавливает заголовок, отображаемый над полем ввода. |
setValueInMsSinceEpoch(valueMsEpoch) | DateTimePicker | Устанавливает предварительно заполненное значение, которое будет установлено в поле ввода. |
setValueInMsSinceEpoch(valueMsEpoch) | DateTimePicker | Устанавливает предварительно заполненное значение, которое будет установлено в поле ввода. |
DecoratedText
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setBottomLabel(text) | DecoratedText | Устанавливает текст метки, который будет использоваться в качестве ключа и отображается под текстовым содержимым. |
setButton(button) | DecoratedText | Устанавливает Button , отображаемую справа от текста. |
setComposeAction(action, composedEmailType) | DecoratedText | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setEndIcon(endIcon) | DecoratedText | Устанавливает необязательный IconImage , который отображается справа от содержимого. |
setOnClickAction(action) | DecoratedText | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | DecoratedText | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | DecoratedText | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
setStartIcon(startIcon) | DecoratedText | Устанавливает необязательный IconImage для отображения перед текстовым содержимым. |
setSwitchControl(switchToSet) | DecoratedText | Устанавливает Switch , который отображается справа от содержимого. |
setText(text) | DecoratedText | Устанавливает текст, который будет использоваться в качестве значения. |
setTopLabel(text) | DecoratedText | Устанавливает текст метки, который будет использоваться в качестве ключа и отображается над текстовым содержимым. |
setWrapText(wrapText) | DecoratedText | Устанавливает, должен ли текст значения отображаться в одной строке или в нескольких строках. |
DisplayStyle
Характеристики
Свойство | Тип | Описание |
---|---|---|
PEEK | Enum | Показывать заголовок карточки внизу дополнительного контента поверх существующего контента. |
REPLACE | Enum | Покажите карточку, заменив существующий контент. |
Divider
DriveItemsSelectedActionResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
DriveItemsSelectedActionResponseBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | DriveItemsSelectedActionResponse | Создает текущий ответ на действие Диска. |
requestFileScope(itemId) | DriveItemsSelectedActionResponseBuilder | Указывает, что ответ запрашивает область файла для контекстно-релевантного элемента на Диске. |
EditorFileScopeActionResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
EditorFileScopeActionResponseBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | EditorFileScopeActionResponse | Создает текущий ответ действия редактора. |
requestFileScopeForActiveDocument() | EditorFileScopeActionResponseBuilder | Запрашивает область drive.file для текущего активного документа редактора. |
FixedFooter
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setPrimaryButton(button) | FixedFooter | Установите основную кнопку в фиксированном нижнем колонтитуле. |
setSecondaryButton(button) | FixedFooter | Установите дополнительную кнопку в фиксированном нижнем колонтитуле. |
Grid
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addItem(gridItem) | Grid | Добавляет новый элемент сетки в сетку. |
setAuthorizationAction(action) | Grid | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setBorderStyle(borderStyle) | Grid | Устанавливает стиль границы, применяемый к каждому элементу сетки. |
setComposeAction(action, composedEmailType) | Grid | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setNumColumns(numColumns) | Grid | Количество столбцов, отображаемых в сетке. |
setOnClickAction(action) | Grid | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | Grid | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | Grid | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
setTitle(title) | Grid | Устанавливает текст заголовка сетки. |
GridItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setIdentifier(id) | GridItem | Устанавливает идентификатор элемента сетки. |
setImage(image) | GridItem | Устанавливает изображение для этого элемента сетки. |
setLayout(layout) | GridItem | Устанавливает макет текста и изображения для элемента сетки. |
setSubtitle(subtitle) | GridItem | Устанавливает подзаголовок элемента сетки. |
setTextAlignment(alignment) | GridItem | Устанавливает горизонтальное выравнивание элемента сетки. |
setTitle(title) | GridItem | Устанавливает текст заголовка элемента сетки. |
GridItemLayout
Характеристики
Свойство | Тип | Описание |
---|---|---|
TEXT_BELOW | Enum | Заголовок и подзаголовок отображаются под изображением элемента сетки. |
TEXT_ABOVE | Enum | Заголовок и подзаголовок отображаются над изображением элемента сетки. |
HorizontalAlignment
Характеристики
Свойство | Тип | Описание |
---|---|---|
START | Enum | Выровняйте виджет по началу предложения. |
CENTER | Enum | Выровняйте виджет по центру. |
END | Enum | Выровняйте виджет по концу предложения. |
Icon
Характеристики
Свойство | Тип | Описание |
---|---|---|
NONE | Enum | Нет значка. |
AIRPLANE | Enum | ![]() |
BOOKMARK | Enum | ![]() |
BUS | Enum | ![]() |
CAR | Enum | ![]() |
CLOCK | Enum | ![]() |
CONFIRMATION_NUMBER_ICON | Enum | ![]() |
DOLLAR | Enum | ![]() |
DESCRIPTION | Enum | ![]() |
EMAIL | Enum | ![]() |
EVENT_PERFORMER | Enum | ![]() |
EVENT_SEAT | Enum | ![]() |
FLIGHT_ARRIVAL | Enum | ![]() |
FLIGHT_DEPARTURE | Enum | ![]() |
HOTEL | Enum | ![]() |
HOTEL_ROOM_TYPE | Enum | ![]() |
INVITE | Enum | ![]() |
MAP_PIN | Enum | ![]() |
MEMBERSHIP | Enum | ![]() |
MULTIPLE_PEOPLE | Enum | ![]() |
OFFER | Enum | ![]() |
PERSON | Enum | ![]() |
PHONE | Enum | ![]() |
RESTAURANT_ICON | Enum | ![]() |
SHOPPING_CART | Enum | ![]() |
STAR | Enum | ![]() |
STORE | Enum | ![]() |
TICKET | Enum | ![]() |
TRAIN | Enum | ![]() |
VIDEO_CAMERA | Enum | ![]() |
VIDEO_PLAY | Enum | ![]() |
IconImage
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAltText(altText) | IconImage | Устанавливает альтернативный текст URL-адреса, который используется для обеспечения доступности. |
setIcon(icon) | IconImage | Устанавливает предопределенный значок, если URL-адрес не установлен. |
setIconUrl(url) | IconImage | Устанавливает URL-адрес значка, если значок не установлен. |
setImageCropType(imageCropType) | IconImage | Устанавливает стиль обрезки изображения. |
Image
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAltText(altText) | Image | Устанавливает альтернативный текст изображения для доступности. |
setAuthorizationAction(action) | Image | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setComposeAction(action, composedEmailType) | Image | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setImageUrl(url) | Image | Устанавливает изображение для использования, предоставляя его URL-адрес или строку данных. |
setOnClickAction(action) | Image | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | Image | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | Image | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
ImageButton
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAltText(altText) | ImageButton | Устанавливает альтернативный текст кнопки для специальных возможностей. |
setAuthorizationAction(action) | ImageButton | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setComposeAction(action, composedEmailType) | ImageButton | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setIcon(icon) | ImageButton | Устанавливает предопределенный Icon для отображения на кнопке. |
setIconUrl(url) | ImageButton | Устанавливает URL-адрес изображения, которое будет использоваться в качестве значка этой кнопки. |
setOnClickAction(action) | ImageButton | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | ImageButton | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | ImageButton | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
ImageComponent
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAltText(altText) | ImageComponent | Устанавливает альтернативный текст изображения. |
setBorderStyle(borderStyle) | ImageComponent | Устанавливает стиль границы, применяемый к изображению. |
setCropStyle(imageCropStyle) | ImageComponent | Устанавливает стиль обрезки изображения. |
setImageUrl(url) | ImageComponent | Устанавливает URL-адрес изображения. |
ImageCropStyle
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAspectRatio(ratio) | ImageCropStyle | Устанавливает соотношение сторон, которое будет использоваться, если тип обрезки — RECTANGLE_CUSTOM . |
setImageCropType(type) | ImageCropStyle | Устанавливает тип обрезки изображения. |
ImageCropType
Характеристики
Свойство | Тип | Описание |
---|---|---|
SQUARE | Enum | Стиль обрезки квадратной формы. |
CIRCLE | Enum | Стиль обрезки в форме круга. |
RECTANGLE_CUSTOM | Enum | Стиль обрезки прямоугольной формы с настраиваемым соотношением сторон. |
RECTANGLE_4_3 | Enum | Стиль обрезки прямоугольной формы с соотношением сторон 4:3. |
ImageStyle
Характеристики
Свойство | Тип | Описание |
---|---|---|
SQUARE | Enum | Никакой обрезки. |
CIRCLE | Enum | Обрезаем до формы круга. |
KeyValue
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAuthorizationAction(action) |
| Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setComposeAction(action, composedEmailType) |
| Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setOnClickAction(action) |
| Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) |
| Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) |
| Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
LoadIndicator
Характеристики
Свойство | Тип | Описание |
---|---|---|
SPINNER | Enum | Используйте вращающийся индикатор. |
NONE | Enum | Не используйте индикатор. |
Navigation
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
popCard() | Navigation | Извлекает карточку из стека навигации. |
popToNamedCard(cardName) | Navigation | Переход к указанной карте по ее имени. |
popToRoot() | Navigation | Перемещает стопку карт на корневую карту. |
printJson() | String | Печатает JSON-представление этого объекта. |
pushCard(card) | Navigation | Помещает данную карту в стек. |
updateCard(card) | Navigation | Производит замену текущей карты на месте. |
Notification
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setText(text) | Notification | Устанавливает текст, отображаемый в уведомлении. |
OnClose
Характеристики
Свойство | Тип | Описание |
---|---|---|
NOTHING | Enum | Ничего не делайте при закрытии. |
RELOAD | Enum | Перезагружает дополнение при закрытии окна. |
OpenAs
Характеристики
Свойство | Тип | Описание |
---|---|---|
FULL_SIZE | Enum | Открыть в полном окне или вкладке. |
OVERLAY | Enum | Открыть как наложение, например всплывающее окно. |
OpenLink
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setOnClose(onClose) | OpenLink | Устанавливает поведение действия URL-адреса при закрытии окна или вкладки URL-адреса. |
setOpenAs(openAs) | OpenLink | Устанавливает поведение URL-адреса при его открытии. |
setUrl(url) | OpenLink | Устанавливает URL-адрес для открытия. |
SelectionInput
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addItem(text, value, selected) | SelectionInput | Добавляет новый элемент, который можно выбрать. |
setFieldName(fieldName) | SelectionInput | Устанавливает ключ, который идентифицирует этот ввод выбора в объекте события, который создается при взаимодействии пользовательского интерфейса. |
setOnChangeAction(action) | SelectionInput | Устанавливает Action , которое будет выполняться при каждом изменении входных данных выбора. |
setTitle(title) | SelectionInput | Устанавливает заголовок, который будет отображаться перед полем ввода. |
setType(type) | SelectionInput | Устанавливает тип этого входа. |
SelectionInputType
Характеристики
Свойство | Тип | Описание |
---|---|---|
CHECK_BOX | Enum | Стиль ввода флажка. |
RADIO_BUTTON | Enum | Стиль ввода радиокнопки. |
DROPDOWN | Enum | Стиль ввода выбора выпадающего меню. |
Suggestions
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addSuggestion(suggestion) | Suggestions | Добавьте текстовое предложение. |
addSuggestions(suggestions) | Suggestions | Добавьте список текстовых предложений. |
SuggestionsResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
SuggestionsResponseBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | SuggestionsResponse | Создает текущий ответ предложений и проверяет его. |
setSuggestions(suggestions) | SuggestionsResponseBuilder | Устанавливает предложения, используемые при автозаполнении, в текстовых полях. |
Switch
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setControlType(controlType) | Switch | Устанавливает тип управления переключателем. |
setFieldName(fieldName) | Switch | Устанавливает ключ, идентифицирующий этот переключатель, в объекте события, который создается при взаимодействии пользовательского интерфейса. |
setOnChangeAction(action) | Switch | Устанавливает действие, которое необходимо выполнить при переключении переключателя. |
setSelected(selected) | Switch | Устанавливает, должен ли этот переключатель запускаться как выбранный или невыбранный. |
setValue(value) | Switch | Устанавливает значение, которое отправляется в качестве входных данных формы, когда этот переключатель включен. |
SwitchControlType
Характеристики
Свойство | Тип | Описание |
---|---|---|
SWITCH | Enum | Элемент управления в стиле переключателя для виджета-переключателя. |
CHECK_BOX | Enum | Элемент управления в виде флажка для виджета переключателя. |
TextButton
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setAltText(altText) | TextButton | Устанавливает альтернативный текст кнопки для специальных возможностей. |
setAuthorizationAction(action) | TextButton | Устанавливает действие авторизации, которое открывает URL-адрес потока авторизации при щелчке объекта. |
setBackgroundColor(backgroundColor) | TextButton | Устанавливает цвет фона для кнопки TextButtonStyle.FILLED . |
setComposeAction(action, composedEmailType) | TextButton | Устанавливает действие, которое формирует черновик электронного письма при щелчке объекта. |
setDisabled(disabled) | TextButton | Устанавливает, отключена ли кнопка. |
setOnClickAction(action) | TextButton | Устанавливает действие, которое выполняется при щелчке объекта. |
setOnClickOpenLinkAction(action) | TextButton | Устанавливает действие, которое открывает URL-адрес на вкладке при щелчке объекта. |
setOpenLink(openLink) | TextButton | Устанавливает URL-адрес, который будет открываться при нажатии на объект. |
setText(text) | TextButton | Устанавливает текст, который отображается на кнопке. |
setTextButtonStyle(textButtonStyle) | TextButton | Устанавливает стиль кнопки. |
TextButtonStyle
Характеристики
Свойство | Тип | Описание |
---|---|---|
TEXT | Enum | Обычная текстовая кнопка с четким фоном. |
FILLED | Enum | Текстовая кнопка с цветным фоном. |
TextInput
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setFieldName(fieldName) | TextInput | Устанавливает ключ, который идентифицирует этот текстовый ввод в объекте события, который создается при взаимодействии пользовательского интерфейса. |
setHint(hint) | TextInput | Устанавливает подсказку для ввода текста. |
setMultiline(multiline) | TextInput | Определяет, будет ли вводимый текст отображаться в одной строке или в нескольких строках. |
setOnChangeAction(action) | TextInput | Устанавливает действие, которое будет выполняться при каждом изменении ввода текста. |
setSuggestions(suggestions) | TextInput | Устанавливает предложения для автозаполнения в текстовом поле. |
setSuggestionsAction(suggestionsAction) | TextInput | Устанавливает действие обратного вызова для получения предложений на основе пользовательского ввода для автозаполнения. |
setTitle(title) | TextInput | Устанавливает заголовок, который будет отображаться над полем ввода. |
setValue(value) | TextInput | Устанавливает предварительно заполненное значение, которое будет установлено в поле ввода. |
TextParagraph
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setText(text) | TextParagraph | Устанавливает текст абзаца. |
TimePicker
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
setFieldName(fieldName) | TimePicker | Задает имя поля, которое идентифицирует это средство выбора в объекте события, который создается при взаимодействии пользовательского интерфейса. |
setHours(hours) | TimePicker | Устанавливает предварительно заполненное значение часов для установки в поле ввода. |
setMinutes(minutes) | TimePicker | Устанавливает предварительно заполненное значение минут для установки в поле ввода. |
setOnChangeAction(action) | TimePicker | Устанавливает Action , которое скрипт выполняет при каждом изменении входных данных средства выбора. |
setTitle(title) | TimePicker | Устанавливает заголовок, отображаемый над полем ввода. |
UniversalActionResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
UniversalActionResponseBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | UniversalActionResponse | Создает текущий универсальный ответ действия и проверяет его. |
displayAddOnCards(cardObjects) | UniversalActionResponseBuilder | Отображает дополнение с указанными картами. |
setOpenLink(openLink) | UniversalActionResponseBuilder | Устанавливает URL-адрес, который будет открываться при выборе универсального действия. |
UpdateDraftActionResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
UpdateDraftActionResponseBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
build() | UpdateDraftActionResponse | Создает текущий ответ на проект действия по обновлению и проверяет его. |
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction) | UpdateDraftActionResponseBuilder | Устанавливает действие, которое обновляет получателей скрытой копии электронной почты черновика. |
setUpdateDraftBodyAction(updateDraftBodyAction) | UpdateDraftActionResponseBuilder | Установите действие, которое обновляет тело черновика электронного письма. |
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction) | UpdateDraftActionResponseBuilder | Устанавливает действие, которое обновляет получателей копии черновика. |
setUpdateDraftSubjectAction(updateDraftSubjectAction) | UpdateDraftActionResponseBuilder | Устанавливает действие, которое обновляет тему черновика. |
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction) | UpdateDraftActionResponseBuilder | Устанавливает действие, которое обновляет получателей черновика. |
UpdateDraftBccRecipientsAction
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addUpdateBccRecipients(bccRecipientEmails) | UpdateDraftBccRecipientsAction | Обновляет получателей скрытой копии черновика электронного письма. |
UpdateDraftBodyAction
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addUpdateContent(content, contentType) | UpdateDraftBodyAction | Добавляет указанное содержимое в тело черновика. |
setUpdateType(updateType) | UpdateDraftBodyAction | Устанавливает UpdateDraftBodyType этого действия обновления в тексте черновика. |
UpdateDraftBodyType
Характеристики
Свойство | Тип | Описание |
---|---|---|
IN_PLACE_INSERT | Enum | По умолчанию. |
INSERT_AT_START | Enum | Действия обновления вставляют содержимое в начало тела сообщения. |
INSERT_AT_END | Enum | Действия обновления вставляют содержимое в конец тела сообщения. |
UpdateDraftCcRecipientsAction
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addUpdateCcRecipients(ccRecipientEmails) | UpdateDraftCcRecipientsAction | Обновляет получателей копии черновика электронного письма. |
UpdateDraftSubjectAction
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addUpdateSubject(subject) | UpdateDraftSubjectAction | Обновляет тему черновика электронного письма. |
UpdateDraftToRecipientsAction
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addUpdateToRecipients(toRecipientEmails) | UpdateDraftToRecipientsAction | Обновляет поле «Получателям» черновика электронного письма. |