Class: Google::Apis::ChatV1::GoogleAppsCardV1DecoratedText

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

A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1DecoratedText

Returns a new instance of GoogleAppsCardV1DecoratedText.



1729
1730
1731
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1729

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

Instance Attribute Details

#bottom_label ⇒ String

The text that appears below text. Always wraps. Corresponds to the JSON property bottomLabel

Returns:

  • (String) 


1662
1663
1664
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1662

def bottom_label
  @bottom_label
end

#button ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Button

A text, icon, or text and icon button that users can click. To make an image a clickable button, specify an Image (not an ImageComponent) and set an onClick action. Corresponds to the JSON property button

Returns:



1669
1670
1671
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1669

def button
  @button
end

#end_icon ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Icon

An icon displayed in a widget on a card. Supports built-in and custom icons. Corresponds to the JSON property endIcon

Returns:



1677
1678
1679
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1677

def end_icon
  @end_icon
end

#icon ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Icon

An icon displayed in a widget on a card. Supports built-in and custom icons. Corresponds to the JSON property icon

Returns:



1685
1686
1687
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1685

def icon
  @icon
end

#on_click ⇒ Google::Apis::ChatV1::GoogleAppsCardV1OnClick

Represents how to respond when users click an interactive element on a card, such as a button. Corresponds to the JSON property onClick

Returns:



1691
1692
1693
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1691

def on_click
  @on_click
end

#start_icon ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Icon

An icon displayed in a widget on a card. Supports built-in and custom icons. Corresponds to the JSON property startIcon

Returns:



1699
1700
1701
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1699

def start_icon
  @start_icon
end

#switch_control ⇒ Google::Apis::ChatV1::GoogleAppsCardV1SwitchControl

Either a toggle-style switch or a checkbox inside a decoratedText widget. Only supported in the decoratedText widget. Corresponds to the JSON property switchControl

Returns:



1705
1706
1707
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1705

def switch_control
  @switch_control
end

#text ⇒ String

Required. The primary text. Supports simple formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons. Corresponds to the JSON property text

Returns:

  • (String) 


1714
1715
1716
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1714

def text
  @text
end

#top_label ⇒ String

The text that appears above text. Always truncates. Corresponds to the JSON property topLabel

Returns:

  • (String) 


1719
1720
1721
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1719

def top_label
  @top_label
end

#wrap_text ⇒ Boolean Also known as: wrap_text?

The wrap text setting. If true, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to text, not topLabel and bottomLabel. Corresponds to the JSON property wrapText

Returns:

  • (Boolean) 


1726
1727
1728
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1726

def wrap_text
  @wrap_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1734

def update!(**args)
  @bottom_label = args[:bottom_label] if args.key?(:bottom_label)
  @button = args[:button] if args.key?(:button)
  @end_icon = args[:end_icon] if args.key?(:end_icon)
  @icon = args[:icon] if args.key?(:icon)
  @on_click = args[:on_click] if args.key?(:on_click)
  @start_icon = args[:start_icon] if args.key?(:start_icon)
  @switch_control = args[:switch_control] if args.key?(:switch_control)
  @text = args[:text] if args.key?(:text)
  @top_label = args[:top_label] if args.key?(:top_label)
  @wrap_text = args[:wrap_text] if args.key?(:wrap_text)
end