Class DateTimePicker

An input field that allows users to input a date and time.

Available for Google Workspace Add-ons and Google Chat apps.

const dateTimePicker =
    CardService.newDateTimePicker()
        .setTitle('Enter the date and time.')
        .setFieldName('date_time_field')
        // Set default value as Jan 1, 2018, 3:00 AM UTC. Either a number or
        // string is acceptable.
        .setValueInMsSinceEpoch(1514775600)
        // EDT time is 5 hours behind UTC.
        .setTimeZoneOffsetInMins(-5 * 60)
        .setOnChangeAction(
            CardService.newAction().setFunctionName('handleDateTimeChange'),
        );

Methods

Method	Return type	Brief description
`setFieldName(fieldName)`	`DateTimePicker`	Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction.
`setOnChangeAction(action)`	`DateTimePicker`	Sets an `Action` that the script performs whenever the picker input changes.
`setTimeZoneOffsetInMins(timeZoneOffsetMins)`	`DateTimePicker`	Sets the number of minutes that the time zone should be offset from UTC.
`setTitle(title)`	`DateTimePicker`	Sets the title displayed above the input field.
`setValueInMsSinceEpoch(valueMsEpoch)`	`DateTimePicker`	Sets the prefilled value to be set in the input field.
`setValueInMsSinceEpoch(valueMsEpoch)`	`DateTimePicker`	Sets the prefilled value to be set in 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.