Class TimePicker

AI-generated Key Takeaways

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 setFieldName method requires a unique name to identify the picker in UI interaction events.
setHours and setMinutes allow setting prefilled time values, which are represented as strings in form callback parameters.
setOnChangeAction allows 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.

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

Methods

Method	Return type	Brief description
`setFieldName(fieldName)`	`TimePicker`	Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction.
`setHours(hours)`	`TimePicker`	Sets the prefilled hours value to set in the input field.
`setMinutes(minutes)`	`TimePicker`	Sets the prefilled minutes value to set in the input field.
`setOnChangeAction(action)`	`TimePicker`	Sets an `Action` that the script performs whenever the picker input changes.
`setTitle(title)`	`TimePicker`	Sets the title displayed above the input field.

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.