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 |
|---|---|---|
set | Date | Sets the field name that identifies this picker in the event object that is generated when there is a UI interaction. |
set | Date | Sets an Action that the script performs whenever the picker input changes. |
set | Date | Sets the title displayed above the input field. |
set | Date | Sets the prefilled value to be set in the input field. |
set | Date | 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.
Parameters
| Name | Type | Description |
|---|---|---|
field | String | The name to assign to this input. |
Return
Date — 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
Date — 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
Date — This picker, for chaining.
setValueInMsSinceEpoch(valueMsEpoch)
Sets the prefilled value to be set in the input field.
Parameters
| Name | Type | Description |
|---|---|---|
value | Number | The default value placed in the input as a number, in milliseconds since the epoch. Only the date of the epoch time is used, and the time of the epoch time is discarded. It is always represented as a string in the form callback parameters. |
Return
Date — This picker, for chaining.
setValueInMsSinceEpoch(valueMsEpoch)
Sets the prefilled value to be set in the input field.
Parameters
| Name | Type | Description |
|---|---|---|
value | String | The default value placed in the input as a string, in milliseconds since the epoch. Only the date of the epoch time is used, and the time of the epoch time is discarded. It is always represented as a string in the form callback parameters. |
Return
Date — This picker, for chaining.