Class: Google::Apis::ChatV1::GoogleAppsCardV1Grid

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

Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. Currently supported in dialogs. Support for card messages is coming soon. For example, the following JSON creates a 2 column grid with a single item: "grid": ` "title": "A fine collection of items", "columnCount": 2, " borderStyle": ` "type": "STROKE", "cornerRadius": 4 `, "items": [ ` "image": ` "imageUri": "https://www.example.com/image.png", "cropStyle": ` "type": " SQUARE" `, "borderStyle": ` "type": "STROKE" ` `, "title": "An item", " textAlignment": "CENTER" ` ], "onClick": ` "openLink": ` "url": "https://www. example.com" ` ` `

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1Grid

Returns a new instance of GoogleAppsCardV1Grid.



1638
1639
1640
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1638

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

Instance Attribute Details

#border_style ⇒ Google::Apis::ChatV1::GoogleAppsCardV1BorderStyle

Represents the complete border style applied to items in a widget. Corresponds to the JSON property borderStyle

Returns:



1613
1614
1615
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1613

def border_style
  @border_style
end

#column_count ⇒ Fixnum

The number of columns to display in the grid. A default value is used if this field isn't specified, and that default value is different depending on where the grid is shown (dialog versus companion). Corresponds to the JSON property columnCount

Returns:

  • (Fixnum) 


1620
1621
1622
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1620

def column_count
  @column_count
end

#items ⇒ Array<Google::Apis::ChatV1::GoogleAppsCardV1GridItem>

The items to display in the grid. Corresponds to the JSON property items

Returns:



1625
1626
1627
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1625

def items
  @items
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:



1631
1632
1633
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1631

def on_click
  @on_click
end

#title ⇒ String

The text that displays in the grid header. Corresponds to the JSON property title

Returns:

  • (String) 


1636
1637
1638
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1636

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1643
1644
1645
1646
1647
1648
1649
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1643

def update!(**args)
  @border_style = args[:border_style] if args.key?(:border_style)
  @column_count = args[:column_count] if args.key?(:column_count)
  @items = args[:items] if args.key?(:items)
  @on_click = args[:on_click] if args.key?(:on_click)
  @title = args[:title] if args.key?(:title)
end