Class TimePicker
Stay organized with collections
Save and categorize content based on your preferences.
TimePicker
An input field that allows users to input a time.
Available for Google Workspace add-ons and Google Chat apps.
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'),
);
Detailed documentation
setFieldName(fieldName)
Sets the field name that identifies this picker in the event object that is generated when
there is a UI interaction. The field name is visible to the user. Required; the specified field
name must be unique.
Parameters
| Name | Type | Description |
fieldName | String | The name to assign to this input. |
Return
TimePicker — 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
TimePicker — This picker, 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
TimePicker — This picker, for chaining.
setOnChangeAction(action)
Sets an Action that the script performs whenever the picker input changes.
Parameters
| Name | Type | Description |
action | Action | The action to take. |
Return
TimePicker — 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
TimePicker — This picker, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-30 UTC.
[null,null,["Last updated 2025-01-30 UTC."],[[["\u003cp\u003eTimePicker is an input field that allows users to input a time, available for Google Workspace Add-ons and Google Chat apps.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can prefill the TimePicker with a default time using \u003ccode\u003esetHours\u003c/code\u003e and \u003ccode\u003esetMinutes\u003c/code\u003e, and set a title using \u003ccode\u003esetTitle\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esetFieldName\u003c/code\u003e assigns a unique identifier for the picker, used in event objects for UI interactions.\u003c/p\u003e\n"],["\u003cp\u003eAn \u003ccode\u003eOnChangeAction\u003c/code\u003e can be set to trigger a specific script function whenever the picker's input value is modified.\u003c/p\u003e\n"]]],[],null,["# Class TimePicker\n\nTimePicker\n\nAn input field that allows users to input a time.\n\nAvailable for Google Workspace add-ons and Google Chat apps.\n\n```javascript\nconst dateTimePicker =\n CardService.newTimePicker()\n .setTitle('Enter the time.')\n .setFieldName('time_field')\n // Set default value as 3:30 AM.\n .setHours(3)\n .setMinutes(30)\n .setOnChangeAction(\n CardService.newAction().setFunctionName('handleDateTimeChange'),\n );\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------|\n| [setFieldName(fieldName)](#setFieldName(String)) | [TimePicker](#) | Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction. |\n| [setHours(hours)](#setHours(Integer)) | [TimePicker](#) | Sets the prefilled hours value to set in the input field. |\n| [setMinutes(minutes)](#setMinutes(Integer)) | [TimePicker](#) | Sets the prefilled minutes value to set in the input field. |\n| [setOnChangeAction(action)](#setOnChangeAction(Action)) | [TimePicker](#) | Sets an [Action](/apps-script/reference/card-service/action) that the script performs whenever the picker input changes. |\n| [setTitle(title)](#setTitle(String)) | [TimePicker](#) | Sets the title displayed above the input field. |\n\nDetailed documentation\n----------------------\n\n### `set``Field``Name(fieldName)`\n\nSets the field name that identifies this picker in the event object that is generated when\nthere is a UI interaction. The field name is visible to the user. Required; the specified field\nname must be unique.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|----------|-----------------------------------|\n| `field``Name` | `String` | The name to assign to this input. |\n\n#### Return\n\n\n[TimePicker](#) --- This picker, for chaining.\n\n*** ** * ** ***\n\n### `set``Hours(hours)`\n\nSets the prefilled hours value to set in the input field.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n\n#### Return\n\n\n[TimePicker](#) --- This picker, for chaining.\n\n*** ** * ** ***\n\n### `set``Minutes(minutes)`\n\nSets the prefilled minutes value to set in the input field.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n\n#### Return\n\n\n[TimePicker](#) --- This picker, for chaining.\n\n*** ** * ** ***\n\n### `set``On``Change``Action(action)`\n\nSets an [Action](/apps-script/reference/card-service/action) that the script performs whenever the picker input changes.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------|------------------------------------------------------|---------------------|\n| `action` | [Action](/apps-script/reference/card-service/action) | The action to take. |\n\n#### Return\n\n\n[TimePicker](#) --- This picker, for chaining.\n\n*** ** * ** ***\n\n### `set``Title(title)`\n\nSets the title displayed above the input field.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|------------------------|\n| `title` | `String` | The input field title. |\n\n#### Return\n\n\n[TimePicker](#) --- This picker, for chaining."]]
