GoogleAppsCardV1Icon (Google Chat API v1-rev20251118-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.GoogleAppsCardV1Icon

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleAppsCardV1Icon
extends com.google.api.client.json.GenericJson
```
An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [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

GoogleAppsCardV1Icon()

Constructors
Constructor and Description
`GoogleAppsCardV1Icon()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleAppsCardV1Icon`	`clone()`
`String`	`getAltText()` Optional.
`String`	`getIconUrl()` Display a custom icon hosted at an HTTPS URL.
`String`	`getImageType()` The crop style applied to the image.
`String`	`getKnownIcon()` Display one of the built-in icons provided by Google Workspace.
`GoogleAppsCardV1MaterialIcon`	`getMaterialIcon()` Display one of the [Google Material Icons](https://fonts.google.com/icons).
`GoogleAppsCardV1Icon`	`set(String fieldName, Object value)`
`GoogleAppsCardV1Icon`	`setAltText(String altText)` Optional.
`GoogleAppsCardV1Icon`	`setIconUrl(String iconUrl)` Display a custom icon hosted at an HTTPS URL.
`GoogleAppsCardV1Icon`	`setImageType(String imageType)` The crop style applied to the image.
`GoogleAppsCardV1Icon`	`setKnownIcon(String knownIcon)` Display one of the built-in icons provided by Google Workspace.
`GoogleAppsCardV1Icon`	`setMaterialIcon(GoogleAppsCardV1MaterialIcon materialIcon)` Display one of the [Google Material Icons](https://fonts.google.com/icons).

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
  - GoogleAppsCardV1Icon
```
public GoogleAppsCardV1Icon()
```
- Method Detail
  - getAltText
```
public String getAltText()
```
    Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
    
    Returns:
    
    value or null for none
  - setAltText
```
public GoogleAppsCardV1Icon setAltText(String altText)
```
    Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored.
    
    Parameters:
    
    altText - altText or null for none
  - getIconUrl
```
public String getIconUrl()
```
    Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
    
    Returns:
    
    value or null for none
  - setIconUrl
```
public GoogleAppsCardV1Icon setIconUrl(String iconUrl)
```
    Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`.
    
    Parameters:
    
    iconUrl - iconUrl or null for none
  - getImageType
```
public String getImageType()
```
    The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
    
    Returns:
    
    value or null for none
  - setImageType
```
public GoogleAppsCardV1Icon setImageType(String imageType)
```
    The crop style applied to the image. In some cases, applying a `CIRCLE` crop causes the image to be drawn larger than a built-in icon.
    
    Parameters:
    
    imageType - imageType or null for none
  - getKnownIcon
```
public String getKnownIcon()
```
    Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format- messages#builtinicons).
    
    Returns:
    
    value or null for none
  - setKnownIcon
```
public GoogleAppsCardV1Icon setKnownIcon(String knownIcon)
```
    Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/workspace/chat/format- messages#builtinicons).
    
    Parameters:
    
    knownIcon - knownIcon or null for none
  - getMaterialIcon
```
public GoogleAppsCardV1MaterialIcon getMaterialIcon()
```
    Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined %3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
    
    Returns:
    
    value or null for none
  - setMaterialIcon
```
public GoogleAppsCardV1Icon setMaterialIcon(GoogleAppsCardV1MaterialIcon materialIcon)
```
    Display one of the [Google Material Icons](https://fonts.google.com/icons). For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined %3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), use ``` "material_icon": { "name": "check_box" } ``` [Google Chat apps](https://developers.google.com/workspace/chat):
    
    Parameters:
    
    materialIcon - materialIcon or null for none
  - set
```
public GoogleAppsCardV1Icon set(String fieldName,
                                Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleAppsCardV1Icon clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleAppsCardV1Icon

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

GoogleAppsCardV1Icon

Method Detail

getAltText

setAltText

getIconUrl

setIconUrl

getImageType

setImageType

getKnownIcon

setKnownIcon

getMaterialIcon

setMaterialIcon

set

clone