Class: Google::Apis::ChatV1::GoogleAppsCardV1DateTimePicker

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb

Overview

Lets users input a date, a time, or both a date and a 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1DateTimePicker

Returns a new instance of GoogleAppsCardV1DateTimePicker.



1657
1658
1659
# File 'lib/google/apis/chat_v1/classes.rb', line 1657

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#labelString

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. Corresponds to the JSON property label

Returns:

  • (String)


1617
1618
1619
# File 'lib/google/apis/chat_v1/classes.rb', line 1617

def label
  @label
end

#nameString

The name by which the DateTimePicker is identified in a form input event. For details about working with form inputs, see Receive form data. Corresponds to the JSON property name

Returns:

  • (String)


1624
1625
1626
# File 'lib/google/apis/chat_v1/classes.rb', line 1624

def name
  @name
end

#on_change_actionGoogle::Apis::ChatV1::GoogleAppsCardV1Action

An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. Corresponds to the JSON property onChangeAction



1631
1632
1633
# File 'lib/google/apis/chat_v1/classes.rb', line 1631

def on_change_action
  @on_change_action
end

#timezone_offset_dateFixnum

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. Corresponds to the JSON property timezoneOffsetDate

Returns:

  • (Fixnum)


1638
1639
1640
# File 'lib/google/apis/chat_v1/classes.rb', line 1638

def timezone_offset_date
  @timezone_offset_date
end

#typeString

Whether the widget supports inputting a date, a time, or the date and time. Corresponds to the JSON property type

Returns:

  • (String)


1643
1644
1645
# File 'lib/google/apis/chat_v1/classes.rb', line 1643

def type
  @type
end

#value_ms_epochFixnum

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). Corresponds to the JSON property valueMsEpoch

Returns:

  • (Fixnum)


1655
1656
1657
# File 'lib/google/apis/chat_v1/classes.rb', line 1655

def value_ms_epoch
  @value_ms_epoch
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1662
1663
1664
1665
1666
1667
1668
1669
# File 'lib/google/apis/chat_v1/classes.rb', line 1662

def update!(**args)
  @label = args[:label] if args.key?(:label)
  @name = args[:name] if args.key?(:name)
  @on_change_action = args[:on_change_action] if args.key?(:on_change_action)
  @timezone_offset_date = args[:timezone_offset_date] if args.key?(:timezone_offset_date)
  @type = args[:type] if args.key?(:type)
  @value_ms_epoch = args[:value_ms_epoch] if args.key?(:value_ms_epoch)
end