Class TimePicker
Page Summary
TimePicker is an input field for users to input a time, available for Google Workspace add-ons and Google Chat apps.
Key methods include setting the field name, title, default hours and minutes, and an action to perform when the input changes.
The
setFieldNamemethod requires a unique name to identify the picker in UI interaction events.setHoursandsetMinutesallow setting prefilled time values, which are represented as strings in form callback parameters.setOnChangeActionallows associating a script action with changes made to the picker's input.
An input field that allows users to input a time.
Available for Google Workspace add-ons and Google Chat apps.
constdateTimePicker=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'),);
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Widget | Adds the event action that can be performed on the widget. |
set | Time | Sets the field name that identifies this picker in the event object that is generated whenthere is a UI interaction. |
set | Time | Sets the prefilled hours value to set in the input field. |
set | Widget | Sets the unique ID assigned that's used to identify the widget to be mutated. |
set | Time | Sets the prefilled minutes value to set in the input field. |
set | Time | Sets anAction that the script performs whenever the picker input changes. |
set | Time | Sets the title displayed above the input field. |
set | Widget | Sets the visibility of the widget. |
Detailed documentation
addEventAction(eventAction)
Adds the event action that can be performed on the widget.
Parameters
| Name | Type | Description |
|---|---|---|
event | Event | TheEvent to be added. |
Return
Widget — The Object, for chaining.
setFieldName(fieldName)
Sets the field name that identifies this picker in the event object that is generated whenthere is a UI interaction. The field name is visible to the user. Required; the specified fieldname must be unique.
Parameters
| Name | Type | Description |
|---|---|---|
field | String | The name to assign to this input. |
Return
Time — This picker, for chaining.
setHours(hours)
Sets the prefilled hours value to set in the input field.
Parameters
| Name | Type | Description |
|---|---|---|
hours | Integer | The default hour value placed in the input, range from 0 to 23. It is always represented as a string in the form callback parameters. |
Return
Time — This picker, for chaining.
setId(id)
Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutationis only supported in Add-Ons.
Parameters
| Name | Type | Description |
|---|---|---|
id | String | The id of the widget, with a limit of 64 characters and in format of `[a-zA-Z0-9-]+`. |
Return
Widget — This object, for chaining.
setMinutes(minutes)
Sets the prefilled minutes value to set in the input field.
Parameters
| Name | Type | Description |
|---|---|---|
minutes | Integer | The default minutes value placed in the input, range from 0 to 59. It is always represented as a string in the form callback parameters. |
Return
Time — This picker, for chaining.
setOnChangeAction(action)
Sets anAction that the script performs whenever the picker input changes.
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The action to take. |
Return
Time — This picker, for chaining.
setTitle(title)
Sets the title displayed above the input field.
Parameters
| Name | Type | Description |
|---|---|---|
title | String | The input field title. |
Return
Time — This picker, for chaining.
setVisibility(visibility)
Sets the visibility of the widget. The default value is `VISIBLE`.
Parameters
| Name | Type | Description |
|---|---|---|
visibility | Visibility | TheVisibility of the widget. |
Return
Widget — The Object, for chaining.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.