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

Class GoogleAppsCardV1DecoratedText

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

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. For an example in Google Chat apps, see [Decorated text](https://developers.google.com/chat/ui/widgets/decorated- text). [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
GoogleAppsCardV1DecoratedText()

Method Summary

Modifier and Type	Method and Description
GoogleAppsCardV1DecoratedText	clone()
String	getBottomLabel() The text that appears below `text`.
GoogleAppsCardV1Button	getButton() A button that a user can click to trigger an action.
GoogleAppsCardV1Icon	getEndIcon() An icon displayed after the text.
GoogleAppsCardV1Icon	getIcon() Deprecated in favor of `startIcon`.
GoogleAppsCardV1OnClick	getOnClick() This action is triggered when users click `topLabel` or `bottomLabel`.
GoogleAppsCardV1Icon	getStartIcon() The icon displayed in front of the text.
GoogleAppsCardV1SwitchControl	getSwitchControl() A switch widget that a user can click to change its state and trigger an action.
String	getText() Required.
String	getTopLabel() The text that appears above `text`.
Boolean	getWrapText() The wrap text setting.
GoogleAppsCardV1DecoratedText	set(String fieldName, Object value)
GoogleAppsCardV1DecoratedText	setBottomLabel(String bottomLabel) The text that appears below `text`.
GoogleAppsCardV1DecoratedText	setButton(GoogleAppsCardV1Button button) A button that a user can click to trigger an action.
GoogleAppsCardV1DecoratedText	setEndIcon(GoogleAppsCardV1Icon endIcon) An icon displayed after the text.
GoogleAppsCardV1DecoratedText	setIcon(GoogleAppsCardV1Icon icon) Deprecated in favor of `startIcon`.
GoogleAppsCardV1DecoratedText	setOnClick(GoogleAppsCardV1OnClick onClick) This action is triggered when users click `topLabel` or `bottomLabel`.
GoogleAppsCardV1DecoratedText	setStartIcon(GoogleAppsCardV1Icon startIcon) The icon displayed in front of the text.
GoogleAppsCardV1DecoratedText	setSwitchControl(GoogleAppsCardV1SwitchControl switchControl) A switch widget that a user can click to change its state and trigger an action.
GoogleAppsCardV1DecoratedText	setText(String text) Required.
GoogleAppsCardV1DecoratedText	setTopLabel(String topLabel) The text that appears above `text`.
GoogleAppsCardV1DecoratedText	setWrapText(Boolean wrapText) The wrap text setting.

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

GoogleAppsCardV1DecoratedText

public GoogleAppsCardV1DecoratedText()

Method Detail

getBottomLabel

public String getBottomLabel()

The text that appears below `text`. Always wraps.

Returns:

value or null for none

setBottomLabel

public GoogleAppsCardV1DecoratedText setBottomLabel(String bottomLabel)

The text that appears below `text`. Always wraps.

Parameters:

bottomLabel - bottomLabel or null for none

getButton

public GoogleAppsCardV1Button getButton()

A button that a user can click to trigger an action.

Returns:

value or null for none

setButton

public GoogleAppsCardV1DecoratedText setButton(GoogleAppsCardV1Button button)

A button that a user can click to trigger an action.

Parameters:

button - button or null for none

getEndIcon

public GoogleAppsCardV1Icon getEndIcon()

An icon displayed after the text. Supports [built-in](https://developers.google.com/chat /format-messages#builtinicons) and [custom](https://developers.google.com/chat/format- messages#customicons) icons.

Returns:

value or null for none

setEndIcon

public GoogleAppsCardV1DecoratedText setEndIcon(GoogleAppsCardV1Icon endIcon)

An icon displayed after the text. Supports [built-in](https://developers.google.com/chat /format-messages#builtinicons) and [custom](https://developers.google.com/chat/format- messages#customicons) icons.

Parameters:

endIcon - endIcon or null for none

getIcon

public GoogleAppsCardV1Icon getIcon()

Deprecated in favor of `startIcon`.

Returns:

value or null for none

setIcon

public GoogleAppsCardV1DecoratedText setIcon(GoogleAppsCardV1Icon icon)

Deprecated in favor of `startIcon`.

Parameters:

icon - icon or null for none

getOnClick

public GoogleAppsCardV1OnClick getOnClick()

This action is triggered when users click `topLabel` or `bottomLabel`.

Returns:

value or null for none

setOnClick

public GoogleAppsCardV1DecoratedText setOnClick(GoogleAppsCardV1OnClick onClick)

This action is triggered when users click `topLabel` or `bottomLabel`.

Parameters:

onClick - onClick or null for none

getStartIcon

public GoogleAppsCardV1Icon getStartIcon()

The icon displayed in front of the text.

Returns:

value or null for none

setStartIcon

public GoogleAppsCardV1DecoratedText setStartIcon(GoogleAppsCardV1Icon startIcon)

The icon displayed in front of the text.

Parameters:

startIcon - startIcon or null for none

getSwitchControl

public GoogleAppsCardV1SwitchControl getSwitchControl()

A switch widget that a user can click to change its state and trigger an action.

Returns:

value or null for none

setSwitchControl

public GoogleAppsCardV1DecoratedText setSwitchControl(GoogleAppsCardV1SwitchControl switchControl)

A switch widget that a user can click to change its state and trigger an action.

Parameters:

switchControl - switchControl or null for none

getText

public String getText()

Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/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

setText

public GoogleAppsCardV1DecoratedText setText(String text)

Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/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:

text - text or null for none

getTopLabel

public String getTopLabel()

The text that appears above `text`. Always truncates.

Returns:

value or null for none

setTopLabel

public GoogleAppsCardV1DecoratedText setTopLabel(String topLabel)

The text that appears above `text`. Always truncates.

Parameters:

topLabel - topLabel or null for none

getWrapText

public Boolean getWrapText()

The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.

Returns:

value or null for none

setWrapText

public GoogleAppsCardV1DecoratedText setWrapText(Boolean wrapText)

The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.

Parameters:

wrapText - wrapText or null for none

set

public GoogleAppsCardV1DecoratedText set(String fieldName,
                                         Object value)

Overrides:

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

clone

public GoogleAppsCardV1DecoratedText clone()

Overrides:

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