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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleAppsCardV1Widget
extends com.google.api.client.json.GenericJson
```
Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types.
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

GoogleAppsCardV1Widget()

Constructors
Constructor and Description
`GoogleAppsCardV1Widget()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleAppsCardV1Widget`	`clone()`
`GoogleAppsCardV1ButtonList`	`getButtonList()` A list of buttons.
`GoogleAppsCardV1Columns`	`getColumns()` Displays up to 2 columns.
`GoogleAppsCardV1DateTimePicker`	`getDateTimePicker()` Displays a widget that lets users input a date, time, or date and time.
`GoogleAppsCardV1DecoratedText`	`getDecoratedText()` Displays a decorated text item.
`GoogleAppsCardV1Divider`	`getDivider()` Displays a horizontal line divider between widgets.
`GoogleAppsCardV1Grid`	`getGrid()` Displays a grid with a collection of items.
`String`	`getHorizontalAlignment()` Specifies whether widgets align to the left, right, or center of a column.
`GoogleAppsCardV1Image`	`getImage()` Displays an image.
`GoogleAppsCardV1SelectionInput`	`getSelectionInput()` Displays a selection control that lets users select items.
`GoogleAppsCardV1TextInput`	`getTextInput()` Displays a text box that users can type into.
`GoogleAppsCardV1TextParagraph`	`getTextParagraph()` Displays a text paragraph.
`GoogleAppsCardV1Widget`	`set(String fieldName, Object value)`
`GoogleAppsCardV1Widget`	`setButtonList(GoogleAppsCardV1ButtonList buttonList)` A list of buttons.
`GoogleAppsCardV1Widget`	`setColumns(GoogleAppsCardV1Columns columns)` Displays up to 2 columns.
`GoogleAppsCardV1Widget`	`setDateTimePicker(GoogleAppsCardV1DateTimePicker dateTimePicker)` Displays a widget that lets users input a date, time, or date and time.
`GoogleAppsCardV1Widget`	`setDecoratedText(GoogleAppsCardV1DecoratedText decoratedText)` Displays a decorated text item.
`GoogleAppsCardV1Widget`	`setDivider(GoogleAppsCardV1Divider divider)` Displays a horizontal line divider between widgets.
`GoogleAppsCardV1Widget`	`setGrid(GoogleAppsCardV1Grid grid)` Displays a grid with a collection of items.
`GoogleAppsCardV1Widget`	`setHorizontalAlignment(String horizontalAlignment)` Specifies whether widgets align to the left, right, or center of a column.
`GoogleAppsCardV1Widget`	`setImage(GoogleAppsCardV1Image image)` Displays an image.
`GoogleAppsCardV1Widget`	`setSelectionInput(GoogleAppsCardV1SelectionInput selectionInput)` Displays a selection control that lets users select items.
`GoogleAppsCardV1Widget`	`setTextInput(GoogleAppsCardV1TextInput textInput)` Displays a text box that users can type into.
`GoogleAppsCardV1Widget`	`setTextParagraph(GoogleAppsCardV1TextParagraph textParagraph)` Displays a text paragraph.

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
  - GoogleAppsCardV1Widget
```
public GoogleAppsCardV1Widget()
```
- Method Detail
  - getButtonList
```
public GoogleAppsCardV1ButtonList getButtonList()
```
    A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, "alpha": 1 }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ```
    
    Returns:
    
    value or null for none
  - setButtonList
```
public GoogleAppsCardV1Widget setButtonList(GoogleAppsCardV1ButtonList buttonList)
```
    A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, "alpha": 1 }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ```
    
    Parameters:
    
    buttonList - buttonList or null for none
  - getColumns
```
public GoogleAppsCardV1Columns getColumns()
```
    Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ```
    
    Returns:
    
    value or null for none
  - setColumns
```
public GoogleAppsCardV1Widget setColumns(GoogleAppsCardV1Columns columns)
```
    Displays up to 2 columns. To include more than 2 columns, or to use rows, use the `Grid` widget. For example, the following JSON creates 2 columns that each contain text paragraphs: ``` "columns": { "columnItems": [ { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "First column text paragraph" } } ] }, { "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", "horizontalAlignment": "CENTER", "verticalAlignment": "CENTER", "widgets": [ { "textParagraph": { "text": "Second column text paragraph" } } ] } ] } ```
    
    Parameters:
    
    columns - columns or null for none
  - getDateTimePicker
```
public GoogleAppsCardV1DateTimePicker getDateTimePicker()
```
    Displays a widget that lets users input a date, time, or date and time. For example, the following JSON creates a date time picker to schedule an appointment: ``` "dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": "796435200000" } ```
    
    Returns:
    
    value or null for none
  - setDateTimePicker
```
public GoogleAppsCardV1Widget setDateTimePicker(GoogleAppsCardV1DateTimePicker dateTimePicker)
```
    Displays a widget that lets users input a date, time, or date and time. For example, the following JSON creates a date time picker to schedule an appointment: ``` "dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": "796435200000" } ```
    
    Parameters:
    
    dateTimePicker - dateTimePicker or null for none
  - getDecoratedText
```
public GoogleAppsCardV1DecoratedText getDecoratedText()
```
    Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ```
    
    Returns:
    
    value or null for none
  - setDecoratedText
```
public GoogleAppsCardV1Widget setDecoratedText(GoogleAppsCardV1DecoratedText decoratedText)
```
    Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ```
    
    Parameters:
    
    decoratedText - decoratedText or null for none
  - getDivider
```
public GoogleAppsCardV1Divider getDivider()
```
    Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ```
    
    Returns:
    
    value or null for none
  - setDivider
```
public GoogleAppsCardV1Widget setDivider(GoogleAppsCardV1Divider divider)
```
    Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ```
    
    Parameters:
    
    divider - divider or null for none
  - getGrid
```
public GoogleAppsCardV1Grid getGrid()
```
    Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ```
    
    Returns:
    
    value or null for none
  - setGrid
```
public GoogleAppsCardV1Widget setGrid(GoogleAppsCardV1Grid grid)
```
    Displays a grid with a collection of items. A grid supports any number of columns and items. The number of rows is determined by the upper bounds of the number items divided by the number of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } } ```
    
    Parameters:
    
    grid - grid or null for none
  - getHorizontalAlignment
```
public String getHorizontalAlignment()
```
    Specifies whether widgets align to the left, right, or center of a column.
    
    Returns:
    
    value or null for none
  - setHorizontalAlignment
```
public GoogleAppsCardV1Widget setHorizontalAlignment(String horizontalAlignment)
```
    Specifies whether widgets align to the left, right, or center of a column.
    
    Parameters:
    
    horizontalAlignment - horizontalAlignment or null for none
  - getImage
```
public GoogleAppsCardV1Image getImage()
```
    Displays an image. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" } ```
    
    Returns:
    
    value or null for none
  - setImage
```
public GoogleAppsCardV1Widget setImage(GoogleAppsCardV1Image image)
```
    Displays an image. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" } ```
    
    Parameters:
    
    image - image or null for none
  - getSelectionInput
```
public GoogleAppsCardV1SelectionInput getSelectionInput()
```
    Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
    
    Returns:
    
    value or null for none
  - setSelectionInput
```
public GoogleAppsCardV1Widget setSelectionInput(GoogleAppsCardV1SelectionInput selectionInput)
```
    Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
    
    Parameters:
    
    selectionInput - selectionInput or null for none
  - getTextInput
```
public GoogleAppsCardV1TextInput getTextInput()
```
    Displays a text box that users can type into. For example, the following JSON creates a text input for an email address: ``` "textInput": { "name": "mailing_address", "label": "Mailing Address" } ``` As another example, the following JSON creates a text input for a programming language with static suggestions: ``` "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" } ] } } ```
    
    Returns:
    
    value or null for none
  - setTextInput
```
public GoogleAppsCardV1Widget setTextInput(GoogleAppsCardV1TextInput textInput)
```
    Displays a text box that users can type into. For example, the following JSON creates a text input for an email address: ``` "textInput": { "name": "mailing_address", "label": "Mailing Address" } ``` As another example, the following JSON creates a text input for a programming language with static suggestions: ``` "textInput": { "name": "preferred_programing_language", "label": "Preferred Language", "initialSuggestions": { "items": [ { "text": "C++" }, { "text": "Java" }, { "text": "JavaScript" }, { "text": "Python" } ] } } ```
    
    Parameters:
    
    textInput - textInput or null for none
  - getTextParagraph
```
public GoogleAppsCardV1TextParagraph getTextParagraph()
```
    Displays a text paragraph. Supports simple HTML formatted text. 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). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ```
    
    Returns:
    
    value or null for none
  - setTextParagraph
```
public GoogleAppsCardV1Widget setTextParagraph(GoogleAppsCardV1TextParagraph textParagraph)
```
    Displays a text paragraph. Supports simple HTML formatted text. 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). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ```
    
    Parameters:
    
    textParagraph - textParagraph or null for none
  - set
```
public GoogleAppsCardV1Widget set(String fieldName,
                                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleAppsCardV1Widget clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleAppsCardV1Widget

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

GoogleAppsCardV1Widget

Method Detail

getButtonList

setButtonList

getColumns

setColumns

getDateTimePicker

setDateTimePicker

getDecoratedText

setDecoratedText

getDivider

setDivider

getGrid

setGrid

getHorizontalAlignment

setHorizontalAlignment

getImage

setImage

getSelectionInput

setSelectionInput

getTextInput

setTextInput

getTextParagraph

setTextParagraph

set

clone