com.google.api.services.chat.v1.model

Class GoogleAppsCardV1DateTimePicker

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.chat.v1.model.GoogleAppsCardV1DateTimePicker

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleAppsCardV1DateTimePicker
extends com.google.api.client.json.GenericJson

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](https://developers.google.com/workspace/chat/design-interactive-card- dialog#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](https://developers.google.com/workspace/extend):

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Chat API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleAppsCardV1DateTimePicker()

Method Summary

Modifier and Type	Method and Description
GoogleAppsCardV1DateTimePicker	clone()
HostAppDataSourceMarkup	getHostAppDataSource() A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages.
String	getLabel() The text that prompts users to input a date, a time, or a date and time.
String	getName() The name by which the `DateTimePicker` is identified in a form input event.
GoogleAppsCardV1Action	getOnChangeAction() Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.
Integer	getTimezoneOffsetDate() The number representing the time zone offset from UTC, in minutes.
String	getType() Whether the widget supports inputting a date, a time, or the date and time.
Long	getValueMsEpoch() The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time).
GoogleAppsCardV1DateTimePicker	set(String fieldName, Object value)
GoogleAppsCardV1DateTimePicker	setHostAppDataSource(HostAppDataSourceMarkup hostAppDataSource) A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages.
GoogleAppsCardV1DateTimePicker	setLabel(String label) The text that prompts users to input a date, a time, or a date and time.
GoogleAppsCardV1DateTimePicker	setName(String name) The name by which the `DateTimePicker` is identified in a form input event.
GoogleAppsCardV1DateTimePicker	setOnChangeAction(GoogleAppsCardV1Action onChangeAction) Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.
GoogleAppsCardV1DateTimePicker	setTimezoneOffsetDate(Integer timezoneOffsetDate) The number representing the time zone offset from UTC, in minutes.
GoogleAppsCardV1DateTimePicker	setType(String type) Whether the widget supports inputting a date, a time, or the date and time.
GoogleAppsCardV1DateTimePicker	setValueMsEpoch(Long valueMsEpoch) The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time).

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleAppsCardV1DateTimePicker

public GoogleAppsCardV1DateTimePicker()

Method Detail

getHostAppDataSource

public HostAppDataSourceMarkup getHostAppDataSource()

A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.

Returns:

value or null for none

setHostAppDataSource

public GoogleAppsCardV1DateTimePicker setHostAppDataSource(HostAppDataSourceMarkup hostAppDataSource)

A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.

Parameters:

hostAppDataSource - hostAppDataSource or null for none

getLabel

public String 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`.

Returns:

value or null for none

setLabel

public GoogleAppsCardV1DateTimePicker setLabel(String label)

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`.

Parameters:

label - label or null for none

getName

public String 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](https://developers.google.com/workspace/chat/read-form-data).

Returns:

value or null for none

setName

public GoogleAppsCardV1DateTimePicker setName(String name)

The name by which the `DateTimePicker` is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).

Parameters:

name - name or null for none

getOnChangeAction

public GoogleAppsCardV1Action getOnChangeAction()

Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.

Returns:

value or null for none

setOnChangeAction

public GoogleAppsCardV1DateTimePicker setOnChangeAction(GoogleAppsCardV1Action onChangeAction)

Triggered when the user clicks **Save** or **Clear** from the `DateTimePicker` interface.

Parameters:

onChangeAction - onChangeAction or null for none

getTimezoneOffsetDate

public Integer 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.

Returns:

value or null for none

setTimezoneOffsetDate

public GoogleAppsCardV1DateTimePicker setTimezoneOffsetDate(Integer timezoneOffsetDate)

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.

Parameters:

timezoneOffsetDate - timezoneOffsetDate or null for none

getType

public String getType()

Whether the widget supports inputting a date, a time, or the date and time.

Returns:

value or null for none

setType

public GoogleAppsCardV1DateTimePicker setType(String type)

Whether the widget supports inputting a date, a time, or the date and time.

Parameters:

type - type or null for none

getValueMsEpoch

public Long getValueMsEpoch()

The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_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`).

Returns:

value or null for none

setValueMsEpoch

public GoogleAppsCardV1DateTimePicker setValueMsEpoch(Long valueMsEpoch)

The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_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`).

Parameters:

valueMsEpoch - valueMsEpoch or null for none

set

public GoogleAppsCardV1DateTimePicker set(String fieldName,
                                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleAppsCardV1DateTimePicker clone()

Overrides:

clone in class com.google.api.client.json.GenericJson