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.



1172
1173
1174
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1172

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

Instance Attribute Details

#bottom_label ⇒ String

The formatted text label that shows below the main text. Corresponds to the JSON property bottomLabel

Returns:

  • (String) 


1123
1124
1125
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1123

def bottom_label
  @bottom_label
end

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

A button. Can be a text button or an image button. Corresponds to the JSON property button

Returns:



1128
1129
1130
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1128

def button
  @button
end

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

An icon displayed after the text. Corresponds to the JSON property endIcon

Returns:



1133
1134
1135
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1133

def end_icon
  @end_icon
end

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

Deprecated in favor of start_icon. Corresponds to the JSON property icon

Returns:



1138
1139
1140
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1138

def icon
  @icon
end

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

Only the top and bottom label and content region are clickable. Corresponds to the JSON property onClick

Returns:



1143
1144
1145
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1143

def on_click
  @on_click
end

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

The icon displayed in front of the text. Corresponds to the JSON property startIcon

Returns:



1148
1149
1150
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1148

def start_icon
  @start_icon
end

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

A switch widget can be clicked to change its state or trigger an action. Corresponds to the JSON property switchControl

Returns:



1153
1154
1155
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1153

def switch_control
  @switch_control
end

#text ⇒ String

Required. The main widget formatted text. See Text formatting for details. Corresponds to the JSON property text

Returns:

  • (String) 


1158
1159
1160
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1158

def text
  @text
end

#top_label ⇒ String

The formatted text label that shows above the main text. Corresponds to the JSON property topLabel

Returns:

  • (String) 


1163
1164
1165
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1163

def top_label
  @top_label
end

#wrap_text ⇒ Boolean Also known as: wrap_text?

The wrap text setting. If true, the text is wrapped and displayed in multiline. Otherwise, the text is truncated. Corresponds to the JSON property wrapText

Returns:

  • (Boolean) 


1169
1170
1171
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1169

def wrap_text
  @wrap_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1177

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