java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
      - com.google.protobuf.GeneratedMessageV3
        
        com.google.apps.card.v1.Card

All Implemented Interfaces:: CardOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class Card
extends com.google.protobuf.GeneratedMessageV3
implements CardOrBuilder

 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 the components of a card or
   dialog](https://developers.google.com/workspace/chat/design-components-card-dialog).
 * 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/workspace/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/workspace/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": "<font color=\"#80e27e\">Online</font>"
                  }
                },
                {
                  "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"
                              }
                            ]
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
     }
   ]
 }
 ```

Protobuf type google.apps.card.v1.Card

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Card.Builder`	A card interface displayed in a Google Chat message or Google Workspace Add-on.
`static class`	`Card.CardAction`	A card action is the action associated with the card.
`static interface`	`Card.CardActionOrBuilder`
`static class`	`Card.CardFixedFooter`	A persistent (sticky) footer that that appears at the bottom of the card.
`static interface`	`Card.CardFixedFooterOrBuilder`
`static class`	`Card.CardHeader`	Represents a card header.
`static interface`	`Card.CardHeaderOrBuilder`
`static class`	`Card.DisplayStyle`	In Google Workspace Add-ons, determines how a card is displayed.
`static class`	`Card.DividerStyle`	The divider style of a card.
`static class`	`Card.Section`	A section contains a collection of widgets that are rendered vertically in the order that they're specified.
`static interface`	`Card.SectionOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`CARD_ACTIONS_FIELD_NUMBER`
`static int`	`DISPLAY_STYLE_FIELD_NUMBER`
`static int`	`FIXED_FOOTER_FIELD_NUMBER`
`static int`	`HEADER_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`PEEK_CARD_HEADER_FIELD_NUMBER`
`static int`	`SECTION_DIVIDER_STYLE_FIELD_NUMBER`
`static int`	`SECTIONS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`Card.CardAction`	`getCardActions(int index)`	The card's actions.
`int`	`getCardActionsCount()`	The card's actions.
`java.util.List<Card.CardAction>`	`getCardActionsList()`	The card's actions.
`Card.CardActionOrBuilder`	`getCardActionsOrBuilder(int index)`	The card's actions.
`java.util.List<? extends Card.CardActionOrBuilder>`	`getCardActionsOrBuilderList()`	The card's actions.
`static Card`	`getDefaultInstance()`
`Card`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`Card.DisplayStyle`	`getDisplayStyle()`	In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.
`int`	`getDisplayStyleValue()`	In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.
`Card.CardFixedFooter`	`getFixedFooter()`	The fixed footer shown at the bottom of this card.
`Card.CardFixedFooterOrBuilder`	`getFixedFooterOrBuilder()`	The fixed footer shown at the bottom of this card.
`Card.CardHeader`	`getHeader()`	The header of the card.
`Card.CardHeaderOrBuilder`	`getHeaderOrBuilder()`	The header of the card.
`java.lang.String`	`getName()`	Name of the card.
`com.google.protobuf.ByteString`	`getNameBytes()`	Name of the card.
`com.google.protobuf.Parser<Card>`	`getParserForType()`
`Card.CardHeader`	`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.
`Card.CardHeaderOrBuilder`	`getPeekCardHeaderOrBuilder()`	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.
`Card.DividerStyle`	`getSectionDividerStyle()`	The divider style between sections.
`int`	`getSectionDividerStyleValue()`	The divider style between sections.
`Card.Section`	`getSections(int index)`	Contains a collection of widgets.
`int`	`getSectionsCount()`	Contains a collection of widgets.
`java.util.List<Card.Section>`	`getSectionsList()`	Contains a collection of widgets.
`Card.SectionOrBuilder`	`getSectionsOrBuilder(int index)`	Contains a collection of widgets.
`java.util.List<? extends Card.SectionOrBuilder>`	`getSectionsOrBuilderList()`	Contains a collection of widgets.
`int`	`getSerializedSize()`
`boolean`	`hasFixedFooter()`	The fixed footer shown at the bottom of this card.
`int`	`hashCode()`
`boolean`	`hasHeader()`	The header of the card.
`boolean`	`hasPeekCardHeader()`	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.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Card.Builder`	`newBuilder()`
`static Card.Builder`	`newBuilder(Card prototype)`
`Card.Builder`	`newBuilderForType()`
`protected Card.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected java.lang.Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Card`	`parseDelimitedFrom(java.io.InputStream input)`
`static Card`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Card`	`parseFrom(byte[] data)`
`static Card`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Card`	`parseFrom(com.google.protobuf.ByteString data)`
`static Card`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Card`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Card`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Card`	`parseFrom(java.io.InputStream input)`
`static Card`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Card`	`parseFrom(java.nio.ByteBuffer data)`
`static Card`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Card>`	`parser()`
`Card.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType

Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage
extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail
- HEADER_FIELD_NUMBER
```
public static final int HEADER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SECTIONS_FIELD_NUMBER
```
public static final int SECTIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SECTION_DIVIDER_STYLE_FIELD_NUMBER
```
public static final int SECTION_DIVIDER_STYLE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CARD_ACTIONS_FIELD_NUMBER
```
public static final int CARD_ACTIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FIXED_FOOTER_FIELD_NUMBER
```
public static final int FIXED_FOOTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_STYLE_FIELD_NUMBER
```
public static final int DISPLAY_STYLE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PEEK_CARD_HEADER_FIELD_NUMBER
```
public static final int PEEK_CARD_HEADER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Overrides:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasHeader

public boolean hasHeader()

 The header of the card. A header usually contains a leading image and a
 title. Headers always appear at the top of a card.

.google.apps.card.v1.Card.CardHeader header = 1;

Specified by:: hasHeader in interface CardOrBuilder
Returns:: Whether the header field is set.

getHeader

public Card.CardHeader 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.

.google.apps.card.v1.Card.CardHeader header = 1;

Specified by:: getHeader in interface CardOrBuilder
Returns:: The header.

getHeaderOrBuilder

public Card.CardHeaderOrBuilder getHeaderOrBuilder()

 The header of the card. A header usually contains a leading image and a
 title. Headers always appear at the top of a card.

.google.apps.card.v1.Card.CardHeader header = 1;

Specified by:: getHeaderOrBuilder in interface CardOrBuilder