GoogleAppsCardV1Card (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.GoogleAppsCardV1Card

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleAppsCardV1Card
extends com.google.api.client.json.GenericJson
```
A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. [Card builder](https://addons.gsuite.google.com/uikit/builder) To learn how to build cards, see the following documentation: * For Google Chat apps, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui). * For Google Workspace Add- ons, see [Card-based interfaces](https://developers.google.com/apps-script/add- ons/concepts/cards). **Example: Card message for a Google Chat app** ![Example contact card](https://developers.google.com/chat/images/card_api_reference.png) To create the sample card message in Google Chat, use the following JSON: ``` { "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL", }, "text": "sasha@example.com", } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON", }, "text": "Online", }, }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE", }, "text": "+1 (555) 555-1234", } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share", } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT", } ], } } }, ], } }, ], }, ], }, } ], } ```
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

GoogleAppsCardV1Card()

Constructors
Constructor and Description
`GoogleAppsCardV1Card()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleAppsCardV1Card`	`clone()`
`List<GoogleAppsCardV1CardAction>`	`getCardActions()` The card's actions.
`String`	`getDisplayStyle()` In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.
`GoogleAppsCardV1CardFixedFooter`	`getFixedFooter()` The fixed footer shown at the bottom of this card.
`GoogleAppsCardV1CardHeader`	`getHeader()` The header of the card.
`String`	`getName()` Name of the card.
`GoogleAppsCardV1CardHeader`	`getPeekCardHeader()` When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards.
`String`	`getSectionDividerStyle()` The divider style between sections.
`List<GoogleAppsCardV1Section>`	`getSections()` Contains a collection of widgets.
`GoogleAppsCardV1Card`	`set(String fieldName, Object value)`
`GoogleAppsCardV1Card`	`setCardActions(List<GoogleAppsCardV1CardAction> cardActions)` The card's actions.
`GoogleAppsCardV1Card`	`setDisplayStyle(String displayStyle)` In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.
`GoogleAppsCardV1Card`	`setFixedFooter(GoogleAppsCardV1CardFixedFooter fixedFooter)` The fixed footer shown at the bottom of this card.
`GoogleAppsCardV1Card`	`setHeader(GoogleAppsCardV1CardHeader header)` The header of the card.
`GoogleAppsCardV1Card`	`setName(String name)` Name of the card.
`GoogleAppsCardV1Card`	`setPeekCardHeader(GoogleAppsCardV1CardHeader peekCardHeader)` When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards.
`GoogleAppsCardV1Card`	`setSectionDividerStyle(String sectionDividerStyle)` The divider style between sections.
`GoogleAppsCardV1Card`	`setSections(List<GoogleAppsCardV1Section> sections)` Contains a collection of widgets.

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
  - GoogleAppsCardV1Card
```
public GoogleAppsCardV1Card()
```
- Method Detail
  - getCardActions
```
public List<GoogleAppsCardV1CardAction> getCardActions()
```
    The card's actions. Actions are added to the card's toolbar menu. [Google Workspace Add- ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ```
    
    Returns:
    
    value or null for none
  - setCardActions
```
public GoogleAppsCardV1Card setCardActions(List<GoogleAppsCardV1CardAction> cardActions)
```
    The card's actions. Actions are added to the card's toolbar menu. [Google Workspace Add- ons](https://developers.google.com/workspace/add-ons): For example, the following JSON constructs a card action menu with `Settings` and `Send Feedback` options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ```
    
    Parameters:
    
    cardActions - cardActions or null for none
  - getDisplayStyle
```
public String getDisplayStyle()
```
    In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
    
    Returns:
    
    value or null for none
  - setDisplayStyle
```
public GoogleAppsCardV1Card setDisplayStyle(String displayStyle)
```
    In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
    
    Parameters:
    
    displayStyle - displayStyle or null for none
  - getFixedFooter
```
public GoogleAppsCardV1CardFixedFooter getFixedFooter()
```
    The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
    
    Returns:
    
    value or null for none
  - setFixedFooter
```
public GoogleAppsCardV1Card setFixedFooter(GoogleAppsCardV1CardFixedFooter fixedFooter)
```
    The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
    
    Parameters:
    
    fixedFooter - fixedFooter or null for none
  - getHeader
```
public GoogleAppsCardV1CardHeader getHeader()
```
    The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
    
    Returns:
    
    value or null for none
  - setHeader
```
public GoogleAppsCardV1Card setHeader(GoogleAppsCardV1CardHeader header)
```
    The header of the card. A header usually contains a leading image and a title. Headers always appear at the top of a card.
    
    Parameters:
    
    header - header or null for none
  - getName
```
public String getName()
```
    Name of the card. Used as a card identifier in card navigation. [Google Workspace Add- ons](https://developers.google.com/workspace/add-ons):
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleAppsCardV1Card setName(String name)
```
    Name of the card. Used as a card identifier in card navigation. [Google Workspace Add- ons](https://developers.google.com/workspace/add-ons):
    
    Parameters:
    
    name - name or null for none
  - getPeekCardHeader
```
public GoogleAppsCardV1CardHeader getPeekCardHeader()
```
    When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
    
    Returns:
    
    value or null for none
  - setPeekCardHeader
```
public GoogleAppsCardV1Card setPeekCardHeader(GoogleAppsCardV1CardHeader peekCardHeader)
```
    When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
    
    Parameters:
    
    peekCardHeader - peekCardHeader or null for none
  - getSectionDividerStyle
```
public String getSectionDividerStyle()
```
    The divider style between sections.
    
    Returns:
    
    value or null for none
  - setSectionDividerStyle
```
public GoogleAppsCardV1Card setSectionDividerStyle(String sectionDividerStyle)
```
    The divider style between sections.
    
    Parameters:
    
    sectionDividerStyle - sectionDividerStyle or null for none
  - getSections
```
public List<GoogleAppsCardV1Section> getSections()
```
    Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Card section](https://developers.google.com/chat/ui/widgets/card-section).
    
    Returns:
    
    value or null for none
  - setSections
```
public GoogleAppsCardV1Card setSections(List<GoogleAppsCardV1Section> sections)
```
    Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see [Card section](https://developers.google.com/chat/ui/widgets/card-section).
    
    Parameters:
    
    sections - sections or null for none
  - set
```
public GoogleAppsCardV1Card set(String fieldName,
                                Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleAppsCardV1Card clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleAppsCardV1Card

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

GoogleAppsCardV1Card

Method Detail

getCardActions

setCardActions

getDisplayStyle

setDisplayStyle

getFixedFooter

setFixedFooter

getHeader

setHeader

getName

setName

getPeekCardHeader

setPeekCardHeader

getSectionDividerStyle

setSectionDividerStyle

getSections

setSections

set

clone