Reference documentation and code samples for the Google Apps Chat V1 Client class DateTimePicker.
Lets users input a date, a time, or both a date and a time.
Supports form submission validation. When Action.all_widgets_are_required
is set to true
or this widget is specified in Action.required_widgets
,
the submission action is blocked unless a value is selected. For an example
in Google Chat apps, see Let a user pick a date and
time
.
Users can input text or use the picker to select dates and times. If users
input an invalid date or time, the picker shows an error that prompts users
to input the information correctly. Google Workspace
add-ons and Chat apps
:
Generated from protobuf message google.apps.card.v1.DateTimePicker
Namespace
Google \ Apps \ Card \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The name by which the DateTimePicker
is identified in a form input event. For details about working with form inputs, see Receive form data
.
↳ label
string
The text that prompts users to input a date, a time, or a date and time. For example, if users are scheduling an appointment, use a label such as Appointment date
or Appointment date and time
.
↳ type
int
Whether the widget supports inputting a date, a time, or the date and time.
↳ value_ms_epoch
int|string
Optional. The default value displayed in the widget, in milliseconds since Unix epoch time
. Specify the value based on the type of picker ( DateTimePickerType
): * * DATE_AND_TIME
: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use 1672574400000
. * * DATE_ONLY
: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use 1672531200000
. * * TIME_ONLY
: a time in UTC. For example, to represent 12:00 PM, use 43200000
(or 12 * 60 * 60 * 1000
).
↳ timezone_offset_date
int
The number representing the time zone offset from UTC, in minutes. If set, the value_ms_epoch
is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting.
↳ on_change_action
getName
The name by which the DateTimePicker
is identified in a form input event.
For details about working with form inputs, see Receive form data .
string
setName
The name by which the DateTimePicker
is identified in a form input event.
For details about working with form inputs, see Receive form data .
var
string
$this
getLabel
The text that prompts users to input a date, a time, or a date and time.
For example, if users are scheduling an appointment, use a label such as Appointment date
or Appointment date and time
.
string
setLabel
The text that prompts users to input a date, a time, or a date and time.
For example, if users are scheduling an appointment, use a label such as Appointment date
or Appointment date and time
.
var
string
$this
getType
Whether the widget supports inputting a date, a time, or the date and time.
setType
Whether the widget supports inputting a date, a time, or the date and time.
$this
getValueMsEpoch
Optional. The default value displayed in the widget, in milliseconds since Unix epoch time .
Specify the value based on the type of picker ( DateTimePickerType
):
-
DATE_AND_TIME: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use1672574400000. -
DATE_ONLY: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use1672531200000. -
TIME_ONLY: a time in UTC. For example, to represent 12:00 PM, use43200000(or12 * 60 * 60 * 1000).
int|string
hasValueMsEpoch
clearValueMsEpoch
setValueMsEpoch
Optional. The default value displayed in the widget, in milliseconds since Unix epoch time .
Specify the value based on the type of picker ( DateTimePickerType
):
-
DATE_AND_TIME: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use1672574400000. -
DATE_ONLY: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use1672531200000. -
TIME_ONLY: a time in UTC. For example, to represent 12:00 PM, use43200000(or12 * 60 * 60 * 1000).
var
int|string
$this
getTimezoneOffsetDate
The number representing the time zone offset from UTC, in minutes.
If set, the value_ms_epoch
is displayed in the specified time zone.
If unset, the value defaults to the user's time zone setting.
int
setTimezoneOffsetDate
The number representing the time zone offset from UTC, in minutes.
If set, the value_ms_epoch
is displayed in the specified time zone.
If unset, the value defaults to the user's time zone setting.
var
int
$this
getOnChangeAction
Triggered when the user clicks Saveor Clearfrom the DateTimePicker
interface.
hasOnChangeAction
clearOnChangeAction
setOnChangeAction
Triggered when the user clicks Saveor Clearfrom the DateTimePicker
interface.
$this
