Google Chat V1 API - Class Google::Apps::Card::V1::Card::Section (v0.5.1)

Version latest

• 0.5.1 (latest)
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.2

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Card::V1::Card::Section.

A section contains a collection of widgets that are rendered vertically in the order that they're specified.

Google Workspace Add-ons and Chat apps:

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#collapsible

def collapsible() -> ::Boolean

Returns

• (::Boolean) — Indicates whether this section is collapsible.

  Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking Show more. Users can hide the widgets again by clicking Show less.

  To determine which widgets are hidden, specify uncollapsibleWidgetsCount.

#collapsible=

def collapsible=(value) -> ::Boolean

Parameter

• value (::Boolean) — Indicates whether this section is collapsible.

  Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking Show more. Users can hide the widgets again by clicking Show less.

  To determine which widgets are hidden, specify uncollapsibleWidgetsCount.

Returns

• (::Boolean) — Indicates whether this section is collapsible.

  Collapsible sections hide some or all widgets, but users can expand the section to reveal the hidden widgets by clicking Show more. Users can hide the widgets again by clicking Show less.

  To determine which widgets are hidden, specify uncollapsibleWidgetsCount.

#header

def header() -> ::String

Returns

• (::String) — Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

#header=

def header=(value) -> ::String

Parameter

• value (::String) — Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Returns

• (::String) — Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

#uncollapsible_widgets_count

def uncollapsible_widgets_count() -> ::Integer

Returns

• (::Integer) — The number of uncollapsible widgets which remain visible even when a section is collapsed.

  For example, when a section contains five widgets and the uncollapsibleWidgetsCount is set to 2, the first two widgets are always shown and the last three are collapsed by default. The uncollapsibleWidgetsCount is taken into account only when collapsible is true.

#uncollapsible_widgets_count=

def uncollapsible_widgets_count=(value) -> ::Integer

Parameter

• value (::Integer) — The number of uncollapsible widgets which remain visible even when a section is collapsed.

  For example, when a section contains five widgets and the uncollapsibleWidgetsCount is set to 2, the first two widgets are always shown and the last three are collapsed by default. The uncollapsibleWidgetsCount is taken into account only when collapsible is true.

Returns

• (::Integer) — The number of uncollapsible widgets which remain visible even when a section is collapsed.

  For example, when a section contains five widgets and the uncollapsibleWidgetsCount is set to 2, the first two widgets are always shown and the last three are collapsed by default. The uncollapsibleWidgetsCount is taken into account only when collapsible is true.

#widgets

def widgets() -> ::Array<::Google::Apps::Card::V1::Widget>

Returns

• (::Array<::Google::Apps::Card::V1::Widget>) — All the widgets in the section. Must contain at least one widget.

#widgets=

def widgets=(value) -> ::Array<::Google::Apps::Card::V1::Widget>

Parameter

• value (::Array<::Google::Apps::Card::V1::Widget>) — All the widgets in the section. Must contain at least one widget.

Returns

• (::Array<::Google::Apps::Card::V1::Widget>) — All the widgets in the section. Must contain at least one widget.