Class TimePicker

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

Methods

MethodReturn typeBrief description
addEventAction(eventAction)WidgetAdds the event action that can be performed on the widget.
setFieldName(fieldName)TimePickerSets the field name that identifies this picker in the event object that is generated when there is a UI interaction.
setHours(hours)TimePickerSets the prefilled hours value to set in the input field.
setId(id)WidgetSets the unique ID assigned that's used to identify the widget to be mutated.
setMinutes(minutes)TimePickerSets the prefilled minutes value to set in the input field.
setOnChangeAction(action)TimePickerSets an Action that the script performs whenever the picker input changes.
setTitle(title)TimePickerSets the title displayed above the input field.
setVisibility(visibility)WidgetSets the visibility of the widget.

Detailed documentation

addEventAction(eventAction)

Adds the event action that can be performed on the widget.

Parameters

NameTypeDescription
eventActionEventActionThe EventAction 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 when there is a UI interaction. The field name is visible to the user. Required; the specified field name must be unique.

Parameters

NameTypeDescription
fieldNameStringThe 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

NameTypeDescription
hoursIntegerThe 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.

setId(id)

Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutation is only supported in Add-Ons.

Parameters

NameTypeDescription
idStringThe 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

NameTypeDescription
minutesIntegerThe 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

NameTypeDescription
actionActionThe action to take.

Return

TimePicker — This picker, for chaining.

setTitle(title)

Sets the title displayed above the input field.

Parameters

NameTypeDescription
titleStringThe input field title.

Return

TimePicker — This picker, for chaining.

setVisibility(visibility)

Sets the visibility of the widget. The default value is `VISIBLE`.

Parameters

NameTypeDescription
visibilityVisibilityThe Visibility of the widget.

Return

Widget — The Object, for chaining.