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. For an example in Google Chat apps, see Decorated text. Google Workspace Add- ons and Chat apps:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1DecoratedText

Returns a new instance of GoogleAppsCardV1DecoratedText.



1883
1884
1885
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1883

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) 


1806
1807
1808
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1806

def bottom_label
  @bottom_label
end

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

A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see Button list. To make an image a clickable button, specify an Image ( not an ImageComponent) and set an onClick action. Google Workspace Add- ons and Chat apps: Corresponds to the JSON property button

Returns:



1815
1816
1817
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1815

def button
  @button
end

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

An icon displayed in a widget on a card. For an example in Google Chat apps, see Icon. Supports built-in and custom icons. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property endIcon

Returns:



1825
1826
1827
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1825

def end_icon
  @end_icon
end

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

An icon displayed in a widget on a card. For an example in Google Chat apps, see Icon. Supports built-in and custom icons. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property icon

Returns:



1835
1836
1837
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1835

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. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property onClick

Returns:



1842
1843
1844
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1842

def on_click
  @on_click
end

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

An icon displayed in a widget on a card. For an example in Google Chat apps, see Icon. Supports built-in and custom icons. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property startIcon

Returns:



1852
1853
1854
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1852

def start_icon
  @start_icon
end

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

Either a toggle-style switch or a checkbox inside a decoratedText widget. Google Workspace Add-ons and Chat apps: Only supported in the decoratedText widget. Corresponds to the JSON property switchControl

Returns:



1859
1860
1861
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1859

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) 


1868
1869
1870
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1868

def text
  @text
end

#top_label ⇒ String

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

Returns:

  • (String) 


1873
1874
1875
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1873

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) 


1880
1881
1882
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1880

def wrap_text
  @wrap_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1888

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