Class: Google::Apis::ChatV1::KeyValue

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 UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ KeyValue

Returns a new instance of KeyValue.



3471
3472
3473
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3471

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

Instance Attribute Details

#bottom_label ⇒ String

The text of the bottom label. Formatted text supported. 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 bottomLabel

Returns:

  • (String) 


3424
3425
3426
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3424

def bottom_label
  @bottom_label
end

#button ⇒ Google::Apis::ChatV1::Button

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

Returns:



3429
3430
3431
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3429

def button
  @button
end

#content ⇒ String

The text of the content. Formatted text supported and always required. 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 content

Returns:

  • (String) 


3438
3439
3440
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3438

def content
  @content
end

#content_multiline ⇒ Boolean Also known as: content_multiline?

If the content should be multiline. Corresponds to the JSON property contentMultiline

Returns:

  • (Boolean) 


3443
3444
3445
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3443

def content_multiline
  @content_multiline
end

#icon ⇒ String

An enum value that's replaced by the Chat API with the corresponding icon image. Corresponds to the JSON property icon

Returns:

  • (String) 


3450
3451
3452
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3450

def icon
  @icon
end

#icon_url ⇒ String

The icon specified by a URL. Corresponds to the JSON property iconUrl

Returns:

  • (String) 


3455
3456
3457
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3455

def icon_url
  @icon_url
end

#on_click ⇒ Google::Apis::ChatV1::OnClick

An onclick action (for example, open a link). Corresponds to the JSON property onClick

Returns:



3460
3461
3462
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3460

def on_click
  @on_click
end

#top_label ⇒ String

The text of the top label. Formatted text supported. 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 topLabel

Returns:

  • (String) 


3469
3470
3471
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3469

def top_label
  @top_label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3476

def update!(**args)
  @bottom_label = args[:bottom_label] if args.key?(:bottom_label)
  @button = args[:button] if args.key?(:button)
  @content = args[:content] if args.key?(:content)
  @content_multiline = args[:content_multiline] if args.key?(:content_multiline)
  @icon = args[:icon] if args.key?(:icon)
  @icon_url = args[:icon_url] if args.key?(:icon_url)
  @on_click = args[:on_click] if args.key?(:on_click)
  @top_label = args[:top_label] if args.key?(:top_label)
end