GoogleAppsCardV1Widget (Google Chat API v1-rev20210605-1.31.5)

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 GenericJson
```
A widget is a UI element that presents texts, images, etc.
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
  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.
`GoogleAppsCardV1DateTimePicker`	`getDateTimePicker()` Displays a selection/input widget for date/time.
`GoogleAppsCardV1DecoratedText`	`getDecoratedText()` Displays a decorated text item in this widget.
`GoogleAppsCardV1Divider`	`getDivider()` Displays a divider.
`GoogleAppsCardV1Grid`	`getGrid()` Displays a grid with a collection of items.
`String`	`getHorizontalAlignment()` The horizontal alignment of this widget.
`GoogleAppsCardV1Image`	`getImage()` Displays an image in this widget.
`GoogleAppsCardV1SelectionInput`	`getSelectionInput()` Displays a switch control in this widget.
`GoogleAppsCardV1TextInput`	`getTextInput()` Displays a text input in this widget.
`GoogleAppsCardV1TextParagraph`	`getTextParagraph()` Displays a text paragraph in this widget.
`GoogleAppsCardV1Widget`	`set(String fieldName, Object value)`
`GoogleAppsCardV1Widget`	`setButtonList(GoogleAppsCardV1ButtonList buttonList)` A list of buttons.
`GoogleAppsCardV1Widget`	`setDateTimePicker(GoogleAppsCardV1DateTimePicker dateTimePicker)` Displays a selection/input widget for date/time.
`GoogleAppsCardV1Widget`	`setDecoratedText(GoogleAppsCardV1DecoratedText decoratedText)` Displays a decorated text item in this widget.
`GoogleAppsCardV1Widget`	`setDivider(GoogleAppsCardV1Divider divider)` Displays a divider.
`GoogleAppsCardV1Widget`	`setGrid(GoogleAppsCardV1Grid grid)` Displays a grid with a collection of items.
`GoogleAppsCardV1Widget`	`setHorizontalAlignment(String horizontalAlignment)` The horizontal alignment of this widget.
`GoogleAppsCardV1Widget`	`setImage(GoogleAppsCardV1Image image)` Displays an image in this widget.
`GoogleAppsCardV1Widget`	`setSelectionInput(GoogleAppsCardV1SelectionInput selectionInput)` Displays a switch control in this widget.
`GoogleAppsCardV1Widget`	`setTextInput(GoogleAppsCardV1TextInput textInput)` Displays a text input in this widget.
`GoogleAppsCardV1Widget`	`setTextParagraph(GoogleAppsCardV1TextParagraph textParagraph)` Displays a text paragraph in this widget.

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 filled text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ "button": { "text": "Edit", "Color": { "Red": 255 "Green": 255 "Blue": 255 } "disabled": true }, "button": { "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 filled text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ "button": { "text": "Edit", "Color": { "Red": 255 "Green": 255 "Blue": 255 } "disabled": true }, "button": { "icon": { "knownIcon": "INVITE" "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } }, ] } ```
    
    Parameters:
    
    buttonList - buttonList or null for none
  - getDateTimePicker
```
public GoogleAppsCardV1DateTimePicker getDateTimePicker()
```
    Displays a selection/input widget for date/time. For example, the following JSON creates a date/time picker for an appointment time: ``` "date_time_picker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DateTimePickerType.DATE_AND_TIME", "valueMsEpoch": "796435200000" } ```
    
    Returns:
    
    value or null for none
  - setDateTimePicker
```
public GoogleAppsCardV1Widget setDateTimePicker(GoogleAppsCardV1DateTimePicker dateTimePicker)
```
    Displays a selection/input widget for date/time. For example, the following JSON creates a date/time picker for an appointment time: ``` "date_time_picker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DateTimePickerType.DATE_AND_TIME", "valueMsEpoch": "796435200000" } ```
    
    Parameters:
    
    dateTimePicker - dateTimePicker or null for none
  - getDecoratedText
```
public GoogleAppsCardV1DecoratedText getDecoratedText()
```
    Displays a decorated text item in this widget. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "content": "heba.salam@example.com", "bottomLabel": "This is a new Email address!", "switchWidget": { "name": "has_send_welcome_email_to_heba_salam", "selected": false, "controlType": "ControlType.CHECKBOX" } } ```
    
    Returns:
    
    value or null for none
  - setDecoratedText
```
public GoogleAppsCardV1Widget setDecoratedText(GoogleAppsCardV1DecoratedText decoratedText)
```
    Displays a decorated text item in this widget. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "content": "heba.salam@example.com", "bottomLabel": "This is a new Email address!", "switchWidget": { "name": "has_send_welcome_email_to_heba_salam", "selected": false, "controlType": "ControlType.CHECKBOX" } } ```
    
    Parameters:
    
    decoratedText - decoratedText or null for none
  - getDivider
```
public GoogleAppsCardV1Divider getDivider()
```
    Displays a divider. For example, the following JSON creates a divider: ``` "divider": { } ```
    
    Returns:
    
    value or null for none
  - setDivider
```
public GoogleAppsCardV1Widget setDivider(GoogleAppsCardV1Divider divider)
```
    Displays a divider. 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. For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "numColumns": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4.0 }, "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. For example, the following JSON creates a 2 column grid with a single item: ``` "grid": { "title": "A fine collection of items", "numColumns": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4.0 }, "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()
```
    The horizontal alignment of this widget.
    
    Returns:
    
    value or null for none
  - setHorizontalAlignment
```
public GoogleAppsCardV1Widget setHorizontalAlignment(String horizontalAlignment)
```
    The horizontal alignment of this widget.
    
    Parameters:
    
    horizontalAlignment - horizontalAlignment or null for none
  - getImage
```
public GoogleAppsCardV1Image getImage()
```
    Displays an image in this widget. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://example.com/heba_salam.png" "altText": "Avatar for Heba Salam" } ```
    
    Returns:
    
    value or null for none
  - setImage
```
public GoogleAppsCardV1Widget setImage(GoogleAppsCardV1Image image)
```
    Displays an image in this widget. For example, the following JSON creates an image with alternative text: ``` "image": { "imageUrl": "https://example.com/heba_salam.png" "altText": "Avatar for Heba Salam" } ```
    
    Parameters:
    
    image - image or null for none
  - getSelectionInput
```
public GoogleAppsCardV1SelectionInput getSelectionInput()
```
    Displays a switch control in this widget. For example, the following JSON creates a dropdown selection for size: ``` "switchControl": { "name": "size", "label": "Size" "type": "SelectionType.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 switch control in this widget. For example, the following JSON creates a dropdown selection for size: ``` "switchControl": { "name": "size", "label": "Size" "type": "SelectionType.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 input in this widget. For example, the following JSON creates a text input for mail address: ``` "textInput": { "name": "mailing_address", "label": "Mailing Address" } ``` As another example, the following JSON creates a text input for 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 input in this widget. For example, the following JSON creates a text input for mail address: ``` "textInput": { "name": "mailing_address", "label": "Mailing Address" } ``` As another example, the following JSON creates a text input for 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 in this widget. 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 in this widget. 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 GenericJson
  - clone
```
public GoogleAppsCardV1Widget clone()
```
    Overrides:
    
    clone in class 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

getDateTimePicker

setDateTimePicker

getDecoratedText

setDecoratedText

getDivider

setDivider

getGrid

setGrid

getHorizontalAlignment

setHorizontalAlignment

getImage

setImage

getSelectionInput

setSelectionInput

getTextInput

setTextInput

getTextParagraph

setTextParagraph

set

clone