com.google.api.services.chat.v1.model

Class GoogleAppsCardV1Section

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.chat.v1.model.GoogleAppsCardV1Section

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleAppsCardV1Section
extends com.google.api.client.json.GenericJson

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](https://developers.google.com/workspace/extend):

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Chat API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleAppsCardV1Section()

Method Summary

Modifier and Type	Method and Description
GoogleAppsCardV1Section	clone()
GoogleAppsCardV1CollapseControl	getCollapseControl() Optional.
Boolean	getCollapsible() Indicates whether this section is collapsible.
String	getHeader() Text that appears at the top of a section.
String	getId() A unique ID assigned to the section that's used to identify the section to be mutated.
Integer	getUncollapsibleWidgetsCount() The number of uncollapsible widgets which remain visible even when a section is collapsed.
List<GoogleAppsCardV1Widget>	getWidgets() All the widgets in the section.
GoogleAppsCardV1Section	set(String fieldName, Object value)
GoogleAppsCardV1Section	setCollapseControl(GoogleAppsCardV1CollapseControl collapseControl) Optional.
GoogleAppsCardV1Section	setCollapsible(Boolean collapsible) Indicates whether this section is collapsible.
GoogleAppsCardV1Section	setHeader(String header) Text that appears at the top of a section.
GoogleAppsCardV1Section	setId(String id) A unique ID assigned to the section that's used to identify the section to be mutated.
GoogleAppsCardV1Section	setUncollapsibleWidgetsCount(Integer uncollapsibleWidgetsCount) The number of uncollapsible widgets which remain visible even when a section is collapsed.
GoogleAppsCardV1Section	setWidgets(List<GoogleAppsCardV1Widget> widgets) All the widgets in the section.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleAppsCardV1Section

public GoogleAppsCardV1Section()

Method Detail

getCollapseControl

public GoogleAppsCardV1CollapseControl getCollapseControl()

Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used.

Returns:

value or null for none

setCollapseControl

public GoogleAppsCardV1Section setCollapseControl(GoogleAppsCardV1CollapseControl collapseControl)

Optional. Define the expand and collapse button of the section. This button will be shown only if the section is collapsible. If this field isn't set, the default button is used.

Parameters:

collapseControl - collapseControl or null for none

getCollapsible

public Boolean getCollapsible()

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:

value or null for none

setCollapsible

public GoogleAppsCardV1Section setCollapsible(Boolean collapsible)

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`.

Parameters:

collapsible - collapsible or null for none

getHeader

public String getHeader()

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](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add- ons/concepts/widgets#text_formatting).

Returns:

value or null for none

setHeader

public GoogleAppsCardV1Section setHeader(String header)

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](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add- ons/concepts/widgets#text_formatting).

Parameters:

header - header or null for none

getId

public String getId()

A unique ID assigned to the section that's used to identify the section to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.

Returns:

value or null for none

setId

public GoogleAppsCardV1Section setId(String id)

A unique ID assigned to the section that's used to identify the section to be mutated. The ID has a character limit of 64 characters and should be in the format of `[a-zA-Z0-9-]+`. Available for Google Workspace add-ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.

Parameters:

id - id or null for none

getUncollapsibleWidgetsCount

public Integer getUncollapsibleWidgetsCount()

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:

value or null for none

setUncollapsibleWidgetsCount

public GoogleAppsCardV1Section setUncollapsibleWidgetsCount(Integer uncollapsibleWidgetsCount)

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`.

Parameters:

uncollapsibleWidgetsCount - uncollapsibleWidgetsCount or null for none

getWidgets

public List<GoogleAppsCardV1Widget> getWidgets()

All the widgets in the section. Must contain at least one widget.

Returns:

value or null for none

setWidgets

public GoogleAppsCardV1Section setWidgets(List<GoogleAppsCardV1Widget> widgets)

All the widgets in the section. Must contain at least one widget.

Parameters:

widgets - widgets or null for none

set

public GoogleAppsCardV1Section set(String fieldName,
                                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleAppsCardV1Section clone()

Overrides:

clone in class com.google.api.client.json.GenericJson