Class DateTimePicker

DateTimePicker

一个输入字段，允许用户输入日期和时间。

支持表单提交验证。当 Action.setAllWidgetsAreRequired(allWidgetsAreRequired) 设置为 true，或者通过 Action.addRequiredWidget(requiredWidget) 指定此微件时，除非选择了一个值，否则提交操作会被阻止。

适用于 Google Workspace 插件和 Google Chat 应用。

const dateTimePicker =
    CardService.newDateTimePicker()
        .setTitle('Enter the date and time.')
        .setFieldName('date_time_field')
        // Set default value as Jan 1, 2018, 3:00 AM UTC. Either a number or
        // string is acceptable.
        .setValueInMsSinceEpoch(1514775600)
        // EDT time is 5 hours behind UTC.
        .setTimeZoneOffsetInMins(-5 * 60)
        .setOnChangeAction(
            CardService.newAction().setFunctionName('handleDateTimeChange'),
        );

方法

方法	返回值类型	简介
addEventAction(eventAction)	Widget	添加可在微件上执行的事件操作。
setFieldName(fieldName)	DateTimePicker	设置字段名称，用于在发生界面互动时生成的事件对象中标识此选择器。
setHostAppDataSource(hostAppDataSource)	DateTimePicker	在 Google Workspace Studio 代理中，允许 输入 变量 接受代理中其他步骤的日期时间输出。
setId(id)	Widget	设置分配的唯一 ID，用于标识要更改的微件。
setOnChangeAction(action)	DateTimePicker	设置脚本在选择器输入发生变化时执行的 Action。
setTimeZoneOffsetInMins(timeZoneOffsetMins)	DateTimePicker	设置时区应与 UTC 偏移的分钟数。
setTitle(title)	DateTimePicker	设置显示在输入字段上方的标题。
setValueInMsSinceEpoch(valueMsEpoch)	DateTimePicker	设置要在输入字段中设置的预填充值。
setValueInMsSinceEpoch(valueMsEpoch)	DateTimePicker	设置要在输入字段中设置的预填充值。
setVisibility(visibility)	Widget	设置微件的可见性。

详细文档

addEventAction(eventAction)

添加可在微件上执行的事件操作。

参数

名称	类型	说明
eventAction	EventAction	要添加的 EventAction。

返回

Widget - 用于链式调用的对象。

---

setFieldName(fieldName)

设置字段名称，用于在发生界面互动时生成的事件对象中标识此选择器。用户可以看到字段名称。必需；指定的字段名称必须是唯一的。

参数

名称	类型	说明
fieldName	String	要为此输入分配的名称。

返回

DateTimePicker - 用于链式调用的此选择器。

---

setHostAppDataSource(hostAppDataSource)

在 Google Workspace Studio 代理中，允许 输入 变量 接受代理中其他步骤的日期时间输出。例如，接收 Gmail 邮件的发送时间或安排日历活动时的日期。

仅适用于扩展 Google Workspace Studio 的 Google Workspace 插件。

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const dateTimePicker = CardService.newDateTimePicker()
                          .setTitle('Enter the date and time.')
                          .setFieldName('date_time_field')
                          .setHostAppDataSource(hostAppDataSource);

参数

名称	类型	说明
hostAppDataSource	HostAppDataSource	数据源。

返回

DateTimePicker - 用于链式调用的此选择器。

---

setId(id)

设置分配的唯一 ID，用于标识要更改的微件。仅在插件中支持微件更改。

参数

名称	类型	说明
id	String	微件的 ID，长度上限为 64 个字符，格式为 `[a-zA-Z0-9-]+`。

返回

Widget - 用于链式调用的此对象。

---

setOnChangeAction(action)

设置脚本在选择器输入发生变化时执行的 Action。

参数

名称	类型	说明
action	Action	要执行的操作。

返回

DateTimePicker - 用于链式调用的此选择器。

---

setTimeZoneOffsetInMins(timeZoneOffsetMins)

设置时区应与 UTC 偏移的分钟数。如果设置了此项，日期和时间将以指定的时区显示。如果未设置此项，时间将以用户的时区显示。

参数

名称	类型	说明
timeZoneOffsetMins	Integer	时区与 UTC 偏移的分钟数。

返回

DateTimePicker - 用于链式调用的此选择器。

---

setTitle(title)

设置显示在输入字段上方的标题。

参数

名称	类型	说明
title	String	输入字段标题。

返回

DateTimePicker - 用于链式调用的此选择器。

---

setValueInMsSinceEpoch(valueMsEpoch)

设置要在输入字段中设置的预填充值。

参数

名称	类型	说明
valueMsEpoch	Number	输入中放置的默认值，以数字形式表示，以毫秒为单位，从 纪元起算。在表单回调参数中，它始终以字符串形式表示。

返回

DateTimePicker - 用于链式调用的此选择器。

---

setValueInMsSinceEpoch(valueMsEpoch)

设置要在输入字段中设置的预填充值。

参数

名称	类型	说明
valueMsEpoch	String	输入中放置的默认值，以字符串形式表示，以毫秒为单位，从 纪元起算。在表单回调参数中，它始终以字符串形式表示。

返回

DateTimePicker - 用于链式调用的此选择器。

---

setVisibility(visibility)

设置微件的可见性。默认值为 `VISIBLE`。

参数

名称	类型	说明
visibility	Visibility	微件的 Visibility。

返回

Widget - 用于链式调用的对象。