GoogleAppsCardV1Button (Google Chat API v1-rev20240220-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleAppsCardV1Button
extends com.google.api.client.json.GenericJson
```
A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). To make an image a clickable button, specify an `Image` (not an `ImageComponent`) and set an `onClick` action. [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

GoogleAppsCardV1Button()

Constructors
Constructor and Description
`GoogleAppsCardV1Button()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleAppsCardV1Button`	`clone()`
`String`	`getAltText()` The alternative text that's used for accessibility.
`Color`	`getColor()` If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color.
`Boolean`	`getDisabled()` If `true`, the button is displayed in an inactive state and doesn't respond to user actions.
`GoogleAppsCardV1Icon`	`getIcon()` The icon image.
`GoogleAppsCardV1OnClick`	`getOnClick()` Required.
`String`	`getText()` The text displayed inside the button.
`GoogleAppsCardV1Button`	`set(String fieldName, Object value)`
`GoogleAppsCardV1Button`	`setAltText(String altText)` The alternative text that's used for accessibility.
`GoogleAppsCardV1Button`	`setColor(Color color)` If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color.
`GoogleAppsCardV1Button`	`setDisabled(Boolean disabled)` If `true`, the button is displayed in an inactive state and doesn't respond to user actions.
`GoogleAppsCardV1Button`	`setIcon(GoogleAppsCardV1Icon icon)` The icon image.
`GoogleAppsCardV1Button`	`setOnClick(GoogleAppsCardV1OnClick onClick)` Required.
`GoogleAppsCardV1Button`	`setText(String text)` The text displayed inside the button.

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
  - GoogleAppsCardV1Button
```
public GoogleAppsCardV1Button()
```
- Method Detail
  - getAltText
```
public String getAltText()
```
    The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat".
    
    Returns:
    
    value or null for none
  - setAltText
```
public GoogleAppsCardV1Button setAltText(String altText)
```
    The alternative text that's used for accessibility. Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/chat".
    
    Parameters:
    
    altText - altText or null for none
  - getColor
```
public Color getColor()
```
    If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text. If unset, the image background is white and the font color is blue. For red, green, and blue, the value of each field is a `float` number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale. Optionally set `alpha`, which sets a level of transparency using this equation: ``` pixel color = alpha * (this color) + (1.0 - alpha) * (background color) ``` For `alpha`, a value of `1` corresponds with a solid color, and a value of `0` corresponds with a completely transparent color. For example, the following color represents a half transparent red: ``` "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 } ```
    
    Returns:
    
    value or null for none
  - setColor
```
public GoogleAppsCardV1Button setColor(Color color)
```
    If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text. If unset, the image background is white and the font color is blue. For red, green, and blue, the value of each field is a `float` number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale. Optionally set `alpha`, which sets a level of transparency using this equation: ``` pixel color = alpha * (this color) + (1.0 - alpha) * (background color) ``` For `alpha`, a value of `1` corresponds with a solid color, and a value of `0` corresponds with a completely transparent color. For example, the following color represents a half transparent red: ``` "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 } ```
    
    Parameters:
    
    color - color or null for none
  - getDisabled
```
public Boolean getDisabled()
```
    If `true`, the button is displayed in an inactive state and doesn't respond to user actions.
    
    Returns:
    
    value or null for none
  - setDisabled
```
public GoogleAppsCardV1Button setDisabled(Boolean disabled)
```
    If `true`, the button is displayed in an inactive state and doesn't respond to user actions.
    
    Parameters:
    
    disabled - disabled or null for none
  - getIcon
```
public GoogleAppsCardV1Icon getIcon()
```
    The icon image. If both `icon` and `text` are set, then the icon appears before the text.
    
    Returns:
    
    value or null for none
  - setIcon
```
public GoogleAppsCardV1Button setIcon(GoogleAppsCardV1Icon icon)
```
    The icon image. If both `icon` and `text` are set, then the icon appears before the text.
    
    Parameters:
    
    icon - icon or null for none
  - getOnClick
```
public GoogleAppsCardV1OnClick getOnClick()
```
    Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
    
    Returns:
    
    value or null for none
  - setOnClick
```
public GoogleAppsCardV1Button setOnClick(GoogleAppsCardV1OnClick onClick)
```
    Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
    
    Parameters:
    
    onClick - onClick or null for none
  - getText
```
public String getText()
```
    The text displayed inside the button.
    
    Returns:
    
    value or null for none
  - setText
```
public GoogleAppsCardV1Button setText(String text)
```
    The text displayed inside the button.
    
    Parameters:
    
    text - text or null for none
  - set
```
public GoogleAppsCardV1Button set(String fieldName,
                                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleAppsCardV1Button clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleAppsCardV1Button

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleAppsCardV1Button

Method Detail

getAltText

setAltText

getColor

setColor

getDisabled

setDisabled

getIcon

setIcon

getOnClick

setOnClick

getText

setText

set

clone