Package com.google.apps.card.v1
Class Card.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<Card.Builder>
com.google.protobuf.GeneratedMessage.Builder<Card.Builder>
com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,Card.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
com.google.apps.card.v1.Card.Builder
- All Implemented Interfaces:
CardOrBuilder
,com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
- Enclosing class:
Card
public static final class Card.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
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**  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
-
Method Summary
Modifier and TypeMethodDescriptionaddAllCardActions
(Iterable<? extends Card.CardAction> values) The card's actions.addAllSections
(Iterable<? extends Card.Section> values) Contains a collection of widgets.addCardActions
(int index, Card.CardAction value) The card's actions.addCardActions
(int index, Card.CardAction.Builder builderForValue) The card's actions.addCardActions
(Card.CardAction value) The card's actions.addCardActions
(Card.CardAction.Builder builderForValue) The card's actions.The card's actions.addCardActionsBuilder
(int index) The card's actions.addRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addSections
(int index, Card.Section value) Contains a collection of widgets.addSections
(int index, Card.Section.Builder builderForValue) Contains a collection of widgets.addSections
(Card.Section value) Contains a collection of widgets.addSections
(Card.Section.Builder builderForValue) Contains a collection of widgets.Contains a collection of widgets.addSectionsBuilder
(int index) Contains a collection of widgets.build()
clear()
The card's actions.In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) The fixed footer shown at the bottom of this card.The header of the card.Name of the card.clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) 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.The divider style between sections.Contains a collection of widgets.clone()
getCardActions
(int index) The card's actions.getCardActionsBuilder
(int index) The card's actions.The card's actions.int
The card's actions.The card's actions.getCardActionsOrBuilder
(int index) The card's actions.List
<? extends Card.CardActionOrBuilder> The card's actions.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.int
In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.The fixed footer shown at the bottom of this card.The fixed footer shown at the bottom of this card.The fixed footer shown at the bottom of this card.The header of the card.The header of the card.The header of the card.getName()
Name of the card.com.google.protobuf.ByteString
Name of the card.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.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.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.The divider style between sections.int
The divider style between sections.getSections
(int index) Contains a collection of widgets.getSectionsBuilder
(int index) Contains a collection of widgets.Contains a collection of widgets.int
Contains a collection of widgets.Contains a collection of widgets.getSectionsOrBuilder
(int index) Contains a collection of widgets.List
<? extends Card.SectionOrBuilder> Contains a collection of widgets.boolean
The fixed footer shown at the bottom of this card.boolean
The header of the card.boolean
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
final boolean
The fixed footer shown at the bottom of this card.mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeHeader
(Card.CardHeader value) The header of the card.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.final Card.Builder
mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) removeCardActions
(int index) The card's actions.removeSections
(int index) Contains a collection of widgets.setCardActions
(int index, Card.CardAction value) The card's actions.setCardActions
(int index, Card.CardAction.Builder builderForValue) The card's actions.setDisplayStyle
(Card.DisplayStyle value) In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.setDisplayStyleValue
(int value) In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`.The fixed footer shown at the bottom of this card.setFixedFooter
(Card.CardFixedFooter.Builder builderForValue) The fixed footer shown at the bottom of this card.setHeader
(Card.CardHeader value) The header of the card.setHeader
(Card.CardHeader.Builder builderForValue) The header of the card.Name of the card.setNameBytes
(com.google.protobuf.ByteString value) Name of the card.setPeekCardHeader
(Card.CardHeader value) 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.setPeekCardHeader
(Card.CardHeader.Builder builderForValue) 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.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) The divider style between sections.setSectionDividerStyleValue
(int value) The divider style between sections.setSections
(int index, Card.Section value) Contains a collection of widgets.setSections
(int index, Card.Section.Builder builderForValue) Contains a collection of widgets.final Card.Builder
setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getParentForChildren
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder
addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<Card.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
setField
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
clearOneof
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
setRepeatedField
public Card.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
addRepeatedField
public Card.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Card.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,
Card.Builder>
-
mergeFrom
public Card.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Card.Builder>
- Throws:
IOException
-
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 interfaceCardOrBuilder
- Returns:
- Whether the header field is set.
-
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 interfaceCardOrBuilder
- Returns:
- The header.
-
setHeader
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;
-
setHeader
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;
-
mergeHeader
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;
-
clearHeader
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;
-
getHeaderBuilder
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;
-
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 interfaceCardOrBuilder
-
getSectionsList
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
- Specified by:
getSectionsList
in interfaceCardOrBuilder
-
getSectionsCount
public int getSectionsCount()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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
- Specified by:
getSectionsCount
in interfaceCardOrBuilder
-
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
- Specified by:
getSections
in interfaceCardOrBuilder
-
setSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
setSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
addSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
addSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
addSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
addSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
addAllSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
clearSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
removeSections
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
getSectionsBuilder
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
getSectionsOrBuilder
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
- Specified by:
getSectionsOrBuilder
in interfaceCardOrBuilder
-
getSectionsOrBuilderList
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
- Specified by:
getSectionsOrBuilderList
in interfaceCardOrBuilder
-
addSectionsBuilder
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
addSectionsBuilder
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
getSectionsBuilderList
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 [Define a section of a card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card).
repeated .google.apps.card.v1.Card.Section sections = 2;
-
getSectionDividerStyleValue
public int getSectionDividerStyleValue()The divider style between sections.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
- Specified by:
getSectionDividerStyleValue
in interfaceCardOrBuilder
- Returns:
- The enum numeric value on the wire for sectionDividerStyle.
-
setSectionDividerStyleValue
The divider style between sections.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
- Parameters:
value
- The enum numeric value on the wire for sectionDividerStyle to set.- Returns:
- This builder for chaining.
-
getSectionDividerStyle
The divider style between sections.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
- Specified by:
getSectionDividerStyle
in interfaceCardOrBuilder
- Returns:
- The sectionDividerStyle.
-
setSectionDividerStyle
The divider style between sections.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
- Parameters:
value
- The sectionDividerStyle to set.- Returns:
- This builder for chaining.
-
clearSectionDividerStyle
The divider style between sections.
.google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
- Returns:
- This builder for chaining.
-
getCardActionsList
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
- Specified by:
getCardActionsList
in interfaceCardOrBuilder
-
getCardActionsCount
public int getCardActionsCount()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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
- Specified by:
getCardActionsCount
in interfaceCardOrBuilder
-
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
- Specified by:
getCardActions
in interfaceCardOrBuilder
-
setCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
setCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
addCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
addCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
addCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
addCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
addAllCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
clearCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
removeCardActions
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
getCardActionsBuilder
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
getCardActionsOrBuilder
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
- Specified by:
getCardActionsOrBuilder
in interfaceCardOrBuilder
-
getCardActionsOrBuilderList
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
- Specified by:
getCardActionsOrBuilderList
in interfaceCardOrBuilder
-
addCardActionsBuilder
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
addCardActionsBuilder
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
getCardActionsBuilderList
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" } } } ] ```
repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
-
getName
Name of the card. Used as a card identifier in card navigation. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;
- Specified by:
getName
in interfaceCardOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Name of the card. Used as a card identifier in card navigation. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;
- Specified by:
getNameBytes
in interfaceCardOrBuilder
- Returns:
- The bytes for name.
-
setName
Name of the card. Used as a card identifier in card navigation. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
Name of the card. Used as a card identifier in card navigation. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;
- Returns:
- This builder for chaining.
-
setNameBytes
Name of the card. Used as a card identifier in card navigation. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
string name = 4;
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
getDisplayStyleValue
public int getDisplayStyleValue()In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;
- Specified by:
getDisplayStyleValue
in interfaceCardOrBuilder
- Returns:
- The enum numeric value on the wire for displayStyle.
-
setDisplayStyleValue
In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;
- Parameters:
value
- The enum numeric value on the wire for displayStyle to set.- Returns:
- This builder for chaining.
-
getDisplayStyle
In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;
- Specified by:
getDisplayStyle
in interfaceCardOrBuilder
- Returns:
- The displayStyle.
-
setDisplayStyle
In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;
- Parameters:
value
- The displayStyle to set.- Returns:
- This builder for chaining.
-
clearDisplayStyle
In Google Workspace Add-ons, sets the display properties of the `peekCardHeader`. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.DisplayStyle display_style = 6;
- Returns:
- This builder for chaining.
-
hasPeekCardHeader
public 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. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;
- Specified by:
hasPeekCardHeader
in interfaceCardOrBuilder
- Returns:
- Whether the peekCardHeader field is set.
-
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;
- Specified by:
getPeekCardHeader
in interfaceCardOrBuilder
- Returns:
- The peekCardHeader.
-
setPeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;
-
setPeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;
-
mergePeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;
-
clearPeekCardHeader
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;
-
getPeekCardHeaderBuilder
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):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;
-
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. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Card.CardHeader peek_card_header = 7;
- Specified by:
getPeekCardHeaderOrBuilder
in interfaceCardOrBuilder
-
setUnknownFields
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Card.Builder>
-