Class DatePicker

AI-generated Key Takeaways

DatePicker is an input field for selecting a date in Google Workspace add-ons and Google Chat apps.
Key methods include setting the field name, title, and default value, as well as defining an action when the input changes.
The setValueInMsSinceEpoch method can accept the default date value as either a number or a string representing milliseconds since the epoch.

An input field that allows inputing a date.

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

const dateTimePicker =
    CardService.newDatePicker()
        .setTitle('Enter the date.')
        .setFieldName('date_field')
        // Set default value as Jan 1, 2018 UTC. Either a number or string is
        // acceptable.
        .setValueInMsSinceEpoch(1514775600)
        .setOnChangeAction(
            CardService.newAction().setFunctionName('handleDateTimeChange'),
        );

Methods

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