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.



1557
1558
1559
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1557

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

Instance Attribute Details

#bottom_label ⇒ String

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

Returns:

  • (String) 


1492
1493
1494
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1492

def bottom_label
  @bottom_label
end

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

A text, icon, or text + 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:



1499
1500
1501
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1499

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:



1507
1508
1509
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1507

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:



1515
1516
1517
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1515

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:



1521
1522
1523
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1521

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:



1529
1530
1531
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1529

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 on the decoratedText widget. Corresponds to the JSON property switchControl

Returns:



1535
1536
1537
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1535

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) 


1542
1543
1544
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1542

def text
  @text
end

#top_label ⇒ String

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

Returns:

  • (String) 


1547
1548
1549
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1547

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) 


1554
1555
1556
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1554

def wrap_text
  @wrap_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1562

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