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

Class KeyValue

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A UI element contains a key (label) and a value (content). This element can also contain some actions such as `onclick` button.

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
KeyValue()

Method Summary

Modifier and Type	Method and Description
KeyValue	clone()
String	getBottomLabel() The text of the bottom label.
Button	getButton() A button that can be clicked to trigger an action.
String	getContent() The text of the content.
Boolean	getContentMultiline() If the content should be multiline.
String	getIcon() An enum value that's replaced by the Chat API with the corresponding icon image.
String	getIconUrl() The icon specified by a URL.
OnClick	getOnClick() The `onclick` action.
String	getTopLabel() The text of the top label.
KeyValue	set(String fieldName, Object value)
KeyValue	setBottomLabel(String bottomLabel) The text of the bottom label.
KeyValue	setButton(Button button) A button that can be clicked to trigger an action.
KeyValue	setContent(String content) The text of the content.
KeyValue	setContentMultiline(Boolean contentMultiline) If the content should be multiline.
KeyValue	setIcon(String icon) An enum value that's replaced by the Chat API with the corresponding icon image.
KeyValue	setIconUrl(String iconUrl) The icon specified by a URL.
KeyValue	setOnClick(OnClick onClick) The `onclick` action.
KeyValue	setTopLabel(String topLabel) The text of the top label.

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

KeyValue

public KeyValue()

Method Detail

getBottomLabel

public String getBottomLabel()

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

setBottomLabel

public KeyValue setBottomLabel(String bottomLabel)

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

bottomLabel - bottomLabel or null for none

getButton

public Button getButton()

A button that can be clicked to trigger an action.

Returns:

value or null for none

setButton

public KeyValue setButton(Button button)

A button that can be clicked to trigger an action.

Parameters:

button - button or null for none

getContent

public String getContent()

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

setContent

public KeyValue setContent(String content)

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

content - content or null for none

getContentMultiline

public Boolean getContentMultiline()

If the content should be multiline.

Returns:

value or null for none

setContentMultiline

public KeyValue setContentMultiline(Boolean contentMultiline)

If the content should be multiline.

Parameters:

contentMultiline - contentMultiline or null for none

getIcon

public String getIcon()

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

Returns:

value or null for none

setIcon

public KeyValue setIcon(String icon)

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

Parameters:

icon - icon or null for none

getIconUrl

public String getIconUrl()

The icon specified by a URL.

Returns:

value or null for none

setIconUrl

public KeyValue setIconUrl(String iconUrl)

The icon specified by a URL.

Parameters:

iconUrl - iconUrl or null for none

getOnClick

public OnClick getOnClick()

The `onclick` action. Only the top label, bottom label, and content region are clickable.

Returns:

value or null for none

setOnClick

public KeyValue setOnClick(OnClick onClick)

The `onclick` action. Only the top label, bottom label, and content region are clickable.

Parameters:

onClick - onClick or null for none

getTopLabel

public String getTopLabel()

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

setTopLabel

public KeyValue setTopLabel(String topLabel)

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

topLabel - topLabel or null for none

set

public KeyValue set(String fieldName,
                    Object value)

Overrides:

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

clone

public KeyValue clone()

Overrides:

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