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.



1561
1562
1563
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1561

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) 


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

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. Currently supported in Chat apps (including dialogs and card messages) and Google Workspace Add-ons. Corresponds to the JSON property button

Returns:



1501
1502
1503
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1501

def button
  @button
end

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

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

Returns:



1509
1510
1511
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1509

def end_icon
  @end_icon
end

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

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

Returns:



1517
1518
1519
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1517

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:



1523
1524
1525
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1523

def on_click
  @on_click
end

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

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

Returns:



1531
1532
1533
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1531

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. Currently supported in dialogs. Support for card messages is coming soon. Corresponds to the JSON property switchControl

Returns:



1540
1541
1542
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1540

def switch_control
  @switch_control
end

#text ⇒ String

Required. The primary text. Supports simple formatting. See Text formatting for formatting details. Corresponds to the JSON property text

Returns:

  • (String) 


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

def text
  @text
end

#top_label ⇒ String

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

Returns:

  • (String) 


1551
1552
1553
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1551

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) 


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

def wrap_text
  @wrap_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1566

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