Card Service

银行卡服务

此服务允许脚本为界面配置和构建卡片和微件组件及行为。使用此服务构建的界面结构会自动在桌面设备和移动设备上提供,因此您无需为它们开发单独的界面。

名称简介
Action一种用于在界面元素内实现交互的操作。
ActionResponse可能会从回调函数(例如表单响应处理程序)返回的响应对象,用于对客户端执行一项或多项操作。
ActionResponseBuilderActionResponse 对象的构建器。
Attachment表示由插件创建的附件。
AuthorizationAction一种授权操作,会在点击时将用户转到 AuthorizationUrl。
AuthorizationException可能会返回的错误,可以触发向用户显示授权卡。
BorderStyle表示可应用于微件的完整边框样式的类。
BorderType表示可以应用于微件的边框类型的枚举。
Button所有按钮的基类。
ButtonSet保存一组 Button,这些对象显示在一行中。
CalendarEventActionResponse表示响应用户当前正在修改的日历活动(例如,点击某个按钮的操作)而做出的响应。
CalendarEventActionResponseBuilderCalendarEventActionResponse 对象的构建器。
Card表示界面中单个视图的上下文卡片
CardAction添加到卡片标题菜单中的可点击菜单项。
CardBuilderCard 对象的构建器。
CardHeaderCard 的标头。
CardSection卡片部分包含微件组,并在它们之间提供视觉间隔。
CardServiceCardService 让您能够创建用于各种 Google 扩展产品(例如 Google Workspace 插件)的通用卡片。
ComposeActionResponse可通过 Gmail 插件中用于撰写操作的回调方法返回的响应对象。
ComposeActionResponseBuilderComposeActionResponse 对象的构建器。
ComposedEmailType一个枚举值,用于指定撰写的电子邮件是独立草稿还是回复草稿。
ContentType用于指定 UpdateDraftActionResponse 所生成内容的内容类型的枚举值。
DatePicker允许输入日期的输入字段。
DateTimePicker允许用户输入日期和时间的输入字段。
DecoratedText一个微件,用于显示具有可选装饰的文本。
DisplayStyle用于定义卡片显示样式的枚举。
Divider水平分隔线。
DriveItemsSelectedActionResponse表示在选择云端硬盘内容后更改云端硬盘的响应,是用户对界面(例如按钮点击)执行的操作进行响应。
DriveItemsSelectedActionResponseBuilderDriveItemsSelectedActionResponse 对象的构建器。
EditorFileScopeActionResponse对编辑器(如 Google 文档、表格或幻灯片)进行修改,以响应在界面中执行的操作。
EditorFileScopeActionResponseBuilderEditorFileScopeActionResponse 对象的构建器。
FixedFooter插件 Card 中显示的固定页脚。
Grid井然有序的网格,用于显示一组网格项。
GridItem用户在网格微件内与之互动的项。
GridItemLayout用于定义 GridItem 的图片和文本样式的枚举。
HorizontalAlignment用于指定微件水平对齐方式的枚举。
Icon可在各种界面对象(如 ImageButtonDecoratedText 微件)中使用的预定义图标。
IconImage预定义图标或来自网址(具有可自定义的剪裁样式)的图标。
Image显示单张图片的微件。
ImageButton包含图片的 ImageButton
ImageComponent一种可添加到网格项的图片组件。
ImageCropStyle表示可应用于图片组件的剪裁样式的类。
ImageCropType表示应用于图片组件的剪裁样式的枚举。
ImageStyle用于定义图片剪裁样式的枚举。
KeyValue此类已弃用。
LoadIndicator用于指定在处理 Action 时显示的加载类型或进度指示器的枚举类型。
Navigation用于控制卡片导航的辅助对象。
Notification作为与界面元素互动的响应而显示的通知。
OnClose枚举通过 OpenLink 打开的网址关闭时要执行的操作。
OpenAs用于指定如何打开网址的枚举。
OpenLink表示用于打开带有某些选项的链接的操作。
SelectionInput允许在一组预定义选项之间进行选择的输入字段。
SelectionInputType选择输入类型。
Suggestions自动补全建议以补充 TextInput 微件。
SuggestionsResponse可以从建议回调函数返回的响应对象。
SuggestionsResponseBuilderSuggestionsResponse 对象的构建器。
Switch支持启用或停用的界面元素。
SwitchControlTypeSwitch widget 控件的类型。
TextButton带有文本标签的 TextButton
TextButtonStyle用于指定 TextButton 样式的枚举。
TextInput一个接受文本输入的输入字段微件。
TextParagraph显示文本并支持基本 HTML 格式的微件。
TimePicker允许用户输入时间的输入字段。
UniversalActionResponse可通过创建通用操作的方法返回的响应对象。
UniversalActionResponseBuilderUniversalActionResponse 对象的构建器。
UpdateDraftActionResponse表示用于更新用户当前正在修改的电子邮件草稿的操作。
UpdateDraftActionResponseBuilderUpdateDraftActionResponse 对象的构建器。
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设置激活操作后要转到的网址。
setStateChanged(stateChanged)ActionResponseBuilder设置指示该操作已改变现有数据状态的标志。

Attachment

方法

方法返回类型简介
setIconUrl(iconUrl)Attachment设置附件的图标网址。
setMimeType(mimeType)Attachment设置附件的 MIME 类型。
setResourceUrl(resourceUrl)Attachment设置附件的资源网址。
setTitle(title)Attachment设置附件的标题。

AuthorizationAction

方法

方法返回类型简介
setAuthorizationUrl(authorizationUrl)AuthorizationAction设置用户从授权提示转到的授权网址。

AuthorizationException

方法

方法返回类型简介
printJson()String输出此对象的 JSON 表示法。
setAuthorizationUrl(authUrl)AuthorizationException设置用户从授权提示转到的授权网址。
setCustomUiCallback(callback)AuthorizationException要生成自定义授权提示而调用的函数的名称。
setResourceDisplayName(name)AuthorizationException设置在请求授权时向用户显示的名称。
throwException()void触发此异常。

BorderStyle

方法

方法返回类型简介
setCornerRadius(radius)BorderStyle设置边框的圆角半径,例如 8。
setStrokeColor(color)BorderStyle设置边框的颜色。
setType(type)BorderStyle设置边框的类型。

BorderType

属性

属性类型说明
NO_BORDEREnum无边框样式。
STROKEEnum描边边框样式。

Button

方法

方法返回类型简介
setAuthorizationAction(action)Button设置一项授权操作,以在点击对象时打开授权流程的网址。
setComposeAction(action, composedEmailType)Button设置在用户点击对象时撰写电子邮件草稿的操作。
setOnClickAction(action)Button设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)Button设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)Button设置在用户点击对象时打开的网址。

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设置一项授权操作,以在点击对象时打开授权流程的网址。
setComposeAction(action, composedEmailType)CardAction设置在用户点击对象时撰写电子邮件草稿的操作。
setOnClickAction(action)CardAction设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)CardAction设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)CardAction设置在用户点击对象时打开的网址。
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通过提供网址或数据字符串,设置要在标头中使用的图片。
setSubtitle(subtitle)CardHeader设置卡片标题的副标题。
setTitle(title)CardHeader设置卡片标题。

CardSection

方法

方法返回类型简介
addWidget(widget)CardSection将指定的 widget 添加到此部分。
setCollapsible(collapsible)CardSection设置该部分是否可以收起。
setHeader(header)CardSection设置相应部分的标题。
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSection设置当此部分收起时仍显示的微件的数量。

CardService

属性

属性类型说明
BorderTypeBorderTypeBorderType 枚举。
ComposedEmailTypeComposedEmailTypeComposedEmailType 枚举。
ContentTypeContentTypeContentType 枚举。
GridItemLayoutGridItemLayoutGridItemLayout 枚举。
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 枚举。
IconIconIcon 枚举。
ImageCropTypeImageCropTypeImageCropType 枚举。
ImageStyleImageStyleImageStyle 枚举。
LoadIndicatorLoadIndicatorLoadIndicator 枚举。
OnCloseOnCloseOnClose 枚举。
OpenAsOpenAsOpenAs 枚举。
SelectionInputTypeSelectionInputTypeSelectionInputType 枚举。
TextButtonStyleTextButtonStyleTextButtonStyle 枚举。
UpdateDraftBodyTypeUpdateDraftBodyTypeUpdateDraftBodyType 枚举。

方法

方法返回类型简介
newAction()Action创建新的 Action
newActionResponseBuilder()ActionResponseBuilder创建新的 ActionResponseBuilder
newAttachment()Attachment创建新的 Attachment
newAuthorizationAction()AuthorizationAction创建新的 AuthorizationAction
newAuthorizationException()AuthorizationException创建新的 AuthorizationException
newBorderStyle()BorderStyle创建新的 BorderStyle
newButtonSet()ButtonSet创建新的 ButtonSet
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilder创建新的 CalendarEventActionResponseBuilder
newCardAction()CardAction创建新的 CardAction
newCardBuilder()CardBuilder创建新的 CardBuilder
newCardHeader()CardHeader创建新的 CardHeader
newCardSection()CardSection创建新的 CardSection
newComposeActionResponseBuilder()ComposeActionResponseBuilder创建新的 ComposeActionResponseBuilder
newDatePicker()DatePicker创建新的 DatePicker
newDateTimePicker()DateTimePicker创建新的 DateTimePicker
newDecoratedText()DecoratedText创建新的 DecoratedText
newDivider()Divider创建新的 Divider
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilder创建新的 DriveItemsSelectedActionResponseBuilder
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilder创建新的 EditorFileScopeActionResponseBuilder
newFixedFooter()FixedFooter创建新的 FixedFooter
newGrid()Grid创建新的 Grid
newGridItem()GridItem创建新的 GridItem
newIconImage()IconImage创建新的 IconImage
newImage()Image创建新的 Image
newImageButton()ImageButton创建新的 ImageButton
newImageComponent()ImageComponent创建新的 ImageComponent
newImageCropStyle()ImageCropStyle创建新的 ImageCropStyle
newKeyValue()KeyValue创建新的 KeyValue
newNavigation()Navigation创建新的 Navigation
newNotification()Notification创建新的 Notification
newOpenLink()OpenLink创建新的 OpenLink
newSelectionInput()SelectionInput创建新的 SelectionInput
newSuggestions()Suggestions创建新的 Suggestions
newSuggestionsResponseBuilder()SuggestionsResponseBuilder创建新的 SuggestionsResponseBuilder
newSwitch()Switch创建新的 Switch
newTextButton()TextButton创建新的 TextButton
newTextInput()TextInput创建新的 TextInput
newTextParagraph()TextParagraph创建新的 TextParagraph
newTimePicker()TimePicker创建新的 TimePicker
newUniversalActionResponseBuilder()UniversalActionResponseBuilder创建新的 UniversalActionResponseBuilder
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilder创建新的 UpdateDraftActionResponseBuilder
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsAction创建新的 UpdateDraftBccRecipientsAction
newUpdateDraftBodyAction()UpdateDraftBodyAction创建新的 UpdateDraftBodyAction
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsAction创建新的 UpdateDraftCcRecipientsAction
newUpdateDraftSubjectAction()UpdateDraftSubjectAction创建新的 UpdateDraftSubjectAction
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsAction创建新的 UpdateDraftToRecipientsAction

ComposeActionResponse

方法

方法返回类型简介
printJson()String输出此对象的 JSON 表示法。

ComposeActionResponseBuilder

方法

方法返回类型简介
build()ComposeActionResponse构建当前的 Compose 操作响应并验证该响应。
setGmailDraft(draft)ComposeActionResponseBuilder设置使用 GmailMessage.createDraftReply(body) 或类似函数创建的 GmailMessage 草稿。

ComposedEmailType

属性

属性类型说明
REPLY_AS_DRAFTEnum回复另一封邮件的草稿。
STANDALONE_DRAFTEnum处于独立状态的草稿。

ContentType

属性

属性类型说明
TEXTEnum表示生成的内容为纯文本。
MUTABLE_HTMLEnum表示生成的内容采用 HTML 格式。
IMMUTABLE_HTMLEnum表示生成的内容采用 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设置一项授权操作,以在点击对象时打开授权流程的网址。
setBottomLabel(text)DecoratedText设置要用作键的标签文本,并将其显示在文本内容下方。
setButton(button)DecoratedText设置显示在文本右侧的 Button
setComposeAction(action, composedEmailType)DecoratedText设置在用户点击对象时撰写电子邮件草稿的操作。
setEndIcon(endIcon)DecoratedText设置在内容右侧显示的可选 IconImage
setOnClickAction(action)DecoratedText设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)DecoratedText设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)DecoratedText设置在用户点击对象时打开的网址。
setStartIcon(startIcon)DecoratedText设置要在文本内容之前显示的可选 IconImage
setSwitchControl(switchToSet)DecoratedText设置显示在内容右侧的 Switch
setText(text)DecoratedText设置要用作值的文本。
setTopLabel(text)DecoratedText设置要用作键的标签文本,并将其显示在文本内容上方。
setWrapText(wrapText)DecoratedText设置值文本应显示在单行还是多行。

DisplayStyle

属性

属性类型说明
PEEKEnum在现有内容的下方显示附加内容卡片标题。
REPLACEEnum通过替换现有内容显示卡片。

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设置一项授权操作,以在点击对象时打开授权流程的网址。
setBorderStyle(borderStyle)Grid设置应用到每个网格项的边框样式。
setComposeAction(action, composedEmailType)Grid设置在用户点击对象时撰写电子邮件草稿的操作。
setNumColumns(numColumns)Grid要在网格中显示的列数。
setOnClickAction(action)Grid设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)Grid设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)Grid设置在用户点击对象时打开的网址。
setTitle(title)Grid设置网格的标题文字。

GridItem

方法

方法返回类型简介
setIdentifier(id)GridItem设置网格项的标识符。
setImage(image)GridItem设置此网格项的图片。
setLayout(layout)GridItem设置网格项的文本和图片的布局。
setSubtitle(subtitle)GridItem设置网格项的副标题。
setTextAlignment(alignment)GridItem设置网格项的水平对齐方式。
setTitle(title)GridItem设置网格项的标题文字。

GridItemLayout

属性

属性类型说明
TEXT_BELOWEnum标题和副标题会显示在网格项的图片下方。
TEXT_ABOVEEnum标题和副标题会显示在网格项的图片上方。

HorizontalAlignment

属性

属性类型说明
STARTEnum将微件与句子一侧的开头对齐。
CENTEREnum将微件与中心对齐。
ENDEnum将微件与句子一侧的末尾对齐。

Icon

属性

属性类型说明
NONEEnum无图标。
AIRPLANEEnum飞机飞行图标
BOOKMARKEnum书签图标
BUSEnum公交车图标
CAREnum汽车图标
CLOCKEnum时钟图标
CONFIRMATION_NUMBER_ICONEnum确认号码图标
DOLLAREnum美元图标
DESCRIPTIONEnum说明图标
EMAILEnum电子邮件图标
EVENT_PERFORMEREnum电子邮件图标
EVENT_SEATEnum活动座位图标
FLIGHT_ARRIVALEnum航班抵达图标
FLIGHT_DEPARTUREEnum航班起飞图标
HOTELEnum酒店图标
HOTEL_ROOM_TYPEEnum酒店图标
INVITEEnum邀请图标
MAP_PINEnum地图图钉图标
MEMBERSHIPEnum会员图标
MULTIPLE_PEOPLEEnum“多人”图标
OFFEREnum“服务”图标
PERSONEnum人形图标
PHONEEnum电话图标
RESTAURANT_ICONEnum餐厅图标
SHOPPING_CARTEnum购物车图标
STAREnum星标图标
STOREEnum商店图标
TICKETEnum票卡图标
TRAINEnum火车图标
VIDEO_CAMERAEnum摄像机图标
VIDEO_PLAYEnum视频播放图标

IconImage

方法

方法返回类型简介
setAltText(altText)IconImage设置用于访问的网址的替代文本。
setIcon(icon)IconImage如果未设置网址,则设置预定义的图标。
setIconUrl(url)IconImage如果未设置图标,则设置图标的网址。
setImageCropType(imageCropType)IconImage设置图片的剪裁样式。

Image

方法

方法返回类型简介
setAltText(altText)Image设置图片的替代文字,以确保可访问性。
setAuthorizationAction(action)Image设置一项授权操作,以在点击对象时打开授权流程的网址。
setComposeAction(action, composedEmailType)Image设置在用户点击对象时撰写电子邮件草稿的操作。
setImageUrl(url)Image通过提供图片的网址或数据字符串,设置要使用的图片。
setOnClickAction(action)Image设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)Image设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)Image设置在用户点击对象时打开的网址。

ImageButton

方法

方法返回类型简介
setAltText(altText)ImageButton设置按钮的替代文字,以提供无障碍功能。
setAuthorizationAction(action)ImageButton设置一项授权操作,以在点击对象时打开授权流程的网址。
setComposeAction(action, composedEmailType)ImageButton设置在用户点击对象时撰写电子邮件草稿的操作。
setIcon(icon)ImageButton设置要在按钮上显示的预定义 Icon
setIconUrl(url)ImageButton设置用作此按钮图标的图片的网址。
setOnClickAction(action)ImageButton设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)ImageButton设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)ImageButton设置在用户点击对象时打开的网址。

ImageComponent

方法

方法返回类型简介
setAltText(altText)ImageComponent设置图片的替代文本。
setBorderStyle(borderStyle)ImageComponent设置应用到图片的边框样式。
setCropStyle(imageCropStyle)ImageComponent设置图片的剪裁样式。
setImageUrl(url)ImageComponent设置图片的网址。

ImageCropStyle

方法

方法返回类型简介
setAspectRatio(ratio)ImageCropStyle设置剪裁类型是 RECTANGLE_CUSTOM 时使用的宽高比。
setImageCropType(type)ImageCropStyle设置图片的剪裁类型。

ImageCropType

属性

属性类型说明
SQUAREEnum方形剪裁样式。
CIRCLEEnum圆形剪裁样式。
RECTANGLE_CUSTOMEnum采用自定义宽高比的矩形剪裁样式。
RECTANGLE_4_3Enum矩形剪裁样式,宽高比为 4:3。

ImageStyle

属性

属性类型说明
SQUAREEnum不剪裁。
CIRCLEEnum剪裁成圆形。

KeyValue

方法

方法返回类型简介
setAuthorizationAction(action)KeyValue设置一项授权操作,以在点击对象时打开授权流程的网址。
setComposeAction(action, composedEmailType)KeyValue设置在用户点击对象时撰写电子邮件草稿的操作。
setOnClickAction(action)KeyValue设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)KeyValue设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)KeyValue设置在用户点击对象时打开的网址。

LoadIndicator

属性

属性类型说明
SPINNEREnum使用旋转图标。
NONEEnum请勿使用指示器。

方法

方法返回类型简介
popCard()Navigation从导航堆栈中弹出卡片。
popToNamedCard(cardName)Navigation按指定卡的名称弹出指定卡片。
popToRoot()Navigation将卡片堆栈弹出到根卡。
printJson()String输出此对象的 JSON 表示法。
pushCard(card)Navigation将给定的卡推送到堆栈。
updateCard(card)Navigation原封不动地更换当前卡。

Notification

方法

方法返回类型简介
setText(text)Notification设置要在通知中显示的文本。

OnClose

属性

属性类型说明
NOTHINGEnum关闭时不执行任何操作。
RELOADEnum在窗口关闭时重新加载插件。

OpenAs

属性

属性类型说明
FULL_SIZEEnum在整个窗口或标签页中打开。
OVERLAYEnum以叠加层(例如弹出式窗口)的形式打开。

方法

方法返回类型简介
setOnClose(onClose)OpenLink设置在网址窗口或标签页关闭时网址操作的行为。
setOpenAs(openAs)OpenLink设置网址打开时的行为。
setUrl(url)OpenLink设置要打开的网址。

SelectionInput

方法

方法返回类型简介
addItem(text, value, selected)SelectionInput添加可选择的新内容。
setFieldName(fieldName)SelectionInput设置用于在有界面互动时生成的事件对象中标识此选择输入的键。
setOnChangeAction(action)SelectionInput设置每当选择输入更改时要执行的 Action
setTitle(title)SelectionInput设置要在输入字段之前显示的标题。
setType(type)SelectionInput设置此输入源的类型。

SelectionInputType

属性

属性类型说明
CHECK_BOXEnum复选框输入样式。
RADIO_BUTTONEnum收音机频道输入样式。
DROPDOWNEnum下拉菜单选择输入样式。

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

属性

属性类型说明
SWITCHEnum开关微件的切换样式控件。
CHECK_BOXEnum开关微件的复选框样式控件。

TextButton

方法

方法返回类型简介
setAltText(altText)TextButton设置按钮的替代文字,以提供无障碍功能。
setAuthorizationAction(action)TextButton设置一项授权操作,以在点击对象时打开授权流程的网址。
setBackgroundColor(backgroundColor)TextButton设置 TextButtonStyle.FILLED 按钮的背景颜色。
setComposeAction(action, composedEmailType)TextButton设置在用户点击对象时撰写电子邮件草稿的操作。
setDisabled(disabled)TextButton设置是否停用该按钮。
setOnClickAction(action)TextButton设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)TextButton设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)TextButton设置在用户点击对象时打开的网址。
setText(text)TextButton设置按钮上显示的文本。
setTextButtonStyle(textButtonStyle)TextButton设置按钮样式。

TextButtonStyle

属性

属性类型说明
TEXTEnum普通文本按钮,背景透明。
FILLEDEnum彩色背景的文本按钮。

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设置在选择通用操作后要打开的网址。

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_INSERTEnum默认此值。
INSERT_AT_STARTEnum更新操作会在邮件正文的开头插入内容。
INSERT_AT_ENDEnum更新操作会在邮件正文的末尾插入内容。

UpdateDraftCcRecipientsAction

方法

方法返回类型简介
addUpdateCcRecipients(ccRecipientEmails)UpdateDraftCcRecipientsAction更新电子邮件草稿的抄送收件人。

UpdateDraftSubjectAction

方法

方法返回类型简介
addUpdateSubject(subject)UpdateDraftSubjectAction更新电子邮件草稿的主题行。

UpdateDraftToRecipientsAction

方法

方法返回类型简介
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsAction更新电子邮件草稿的收件人。

Widget