Class TimePicker

时间选择器

一个输入字段,允许用户输入时间。

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

const dateTimePicker =
    CardService.newTimePicker()
        .setTitle('Enter the time.')
        .setFieldName('time_field')
        // Set default value as 3:30 AM.
        .setHours(3)
        .setMinutes(30)
        .setOnChangeAction(
            CardService.newAction().setFunctionName('handleDateTimeChange'),
        );

方法

方法返回类型简介
addEventAction(eventAction)Widget添加可在 widget 上执行的事件操作。
setFieldName(fieldName)TimePicker设置在发生界面互动时生成的事件对象中用于标识相应选择器的字段名称。
setHours(hours)TimePicker设置要在输入字段中设置的预填充小时值。
setId(id)Widget设置用于标识要发生变异的 widget 的唯一 ID。
setMinutes(minutes)TimePicker设置要在输入字段中设置的预填充分钟值。
setOnChangeAction(action)TimePicker设置一个 Action,每当选择器输入发生变化时,脚本都会执行该 Action
setTitle(title)TimePicker设置显示在输入字段上方的标题。
setVisibility(visibility)Widget设置 widget 的可见性。

详细文档

addEventAction(eventAction)

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

参数

名称类型说明
eventActionEventAction要添加的 EventAction

返回

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


setFieldName(fieldName)

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

参数

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

返回

TimePicker - 此选择器,用于链式调用。


setHours(hours)

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

参数

名称类型说明
hoursInteger放置在输入中的默认小时值,范围为 0 到 23。在表单回调参数中,它始终表示为字符串。

返回

TimePicker - 此选择器,用于链式调用。


setId(id)

设置用于标识要发生变异的 widget 的唯一 ID。只有在插件中支持 widget 突变。

参数

名称类型说明
idString微件的 ID,最多可包含 64 个字符,格式为 `[a-zA-Z0-9-]+`。

返回

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


setMinutes(minutes)

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

参数

名称类型说明
minutesInteger输入中放置的默认分钟值,范围为 0 到 59。在表单回调参数中,它始终表示为字符串。

返回

TimePicker - 此选择器,用于链式调用。


setOnChangeAction(action)

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

参数

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

返回

TimePicker - 此选择器,用于链式调用。


setTitle(title)

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

参数

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

返回

TimePicker - 此选择器,用于链式调用。


setVisibility(visibility)

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

参数

名称类型说明
visibilityVisibility微件的 Visibility

返回

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