Class DateTimePicker

日期时间选择器

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

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

适用于 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'),
        );

方法

方法返回类型简介
setFieldName(fieldName)DateTimePicker设置在发生界面互动时生成的事件对象中用于标识相应选择器的字段名称。
setHostAppDataSource(hostAppDataSource)DateTimePicker在 Google Workspace 流中，允许输入变量接受流中其他步骤的日期时间输出。
setOnChangeAction(action)DateTimePicker设置一个 Action，每当选择器输入发生变化时，脚本都会执行该 Action。
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePicker设置时区与世界协调时间 (UTC) 的偏移分钟数。
setTitle(title)DateTimePicker设置显示在输入字段上方的标题。
setValueInMsSinceEpoch(valueMsEpoch)DateTimePicker设置要在输入字段中设置的预填充值。
setValueInMsSinceEpoch(valueMsEpoch)DateTimePicker设置要在输入字段中设置的预填充值。

详细文档

setFieldName(fieldName)

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

参数

名称类型说明
fieldNameString要为此输入源分配的名称。

返回

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

setHostAppDataSource(hostAppDataSource)

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

仅通过 Gemini Alpha 版计划提供，适用于扩展 Google Workspace Flows 的 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);

参数

名称类型说明
hostAppDataSourceHostAppDataSource数据源。

返回

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

setOnChangeAction(action)

设置一个 Action，每当选择器输入发生变化时，脚本都会执行该 Action。

参数

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

返回

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

setTimeZoneOffsetInMins(timeZoneOffsetMins)

设置时区与世界协调时间 (UTC) 的偏移分钟数。如果设置，则以指定的时区显示日期和时间。如果未设置，则时间以用户的时区显示。

参数

名称类型说明
timeZoneOffsetMinsInteger时区与世界协调时间 (UTC) 的偏移分钟数。

返回

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

setTitle(title)

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

参数

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

返回

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

setValueInMsSinceEpoch(valueMsEpoch)

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

参数

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

返回

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

setValueInMsSinceEpoch(valueMsEpoch)

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

参数

名称类型说明
valueMsEpochString放置在输入中的默认值（以字符串形式表示，自纪元开始以来的毫秒数）。在表单回调参数中，它始终表示为字符串。

返回

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