Interface CardOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Card, Card.Builder

public interface CardOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • hasHeader

      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;
      Returns:
      Whether the header field is set.
    • getHeader

      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;
      Returns:
      The header.
    • getHeaderOrBuilder

      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;
    • getSectionsList

      List<Card.Section> 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;
    • getSections

      Card.Section getSections(int index)
       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;
    • getSectionsCount

      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;
    • getSectionsOrBuilderList

      List<? extends Card.SectionOrBuilder> 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;
    • getSectionsOrBuilder

      Card.SectionOrBuilder getSectionsOrBuilder(int index)
       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

      int getSectionDividerStyleValue()
       The divider style between sections.
       
      .google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
      Returns:
      The enum numeric value on the wire for sectionDividerStyle.
    • getSectionDividerStyle

      Card.DividerStyle getSectionDividerStyle()
       The divider style between sections.
       
      .google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
      Returns:
      The sectionDividerStyle.
    • getCardActionsList

      List<Card.CardAction> 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;
    • getCardActions

      Card.CardAction getCardActions(int index)
       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;
    • getCardActionsCount

      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;
    • getCardActionsOrBuilderList

      List<? extends Card.CardActionOrBuilder> 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;
    • getCardActionsOrBuilder

      Card.CardActionOrBuilder getCardActionsOrBuilder(int index)
       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

      String getName()
       Name of the card. Used as a card identifier in card navigation.
      
       [Google Workspace
       Add-ons](https://developers.google.com/workspace/add-ons):
       
      string name = 4;
      Returns:
      The name.
    • getNameBytes

      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;
      Returns:
      The bytes for name.
    • hasFixedFooter

      boolean hasFixedFooter()
       The fixed footer shown at the bottom of this card.
      
       Setting `fixedFooter` without specifying a `primaryButton` or a
       `secondaryButton` causes an error. For Chat apps, you can use fixed footers
       in
       [dialogs](https://developers.google.com/workspace/chat/dialogs), but not
       [card
       messages](https://developers.google.com/workspace/chat/create-messages#create).
      
       [Google Workspace Add-ons and Chat
       apps](https://developers.google.com/workspace/extend):
       
      .google.apps.card.v1.Card.CardFixedFooter fixed_footer = 5;
      Returns:
      Whether the fixedFooter field is set.
    • getFixedFooter

      Card.CardFixedFooter getFixedFooter()
       The fixed footer shown at the bottom of this card.
      
       Setting `fixedFooter` without specifying a `primaryButton` or a
       `secondaryButton` causes an error. For Chat apps, you can use fixed footers
       in
       [dialogs](https://developers.google.com/workspace/chat/dialogs), but not
       [card
       messages](https://developers.google.com/workspace/chat/create-messages#create).
      
       [Google Workspace Add-ons and Chat
       apps](https://developers.google.com/workspace/extend):
       
      .google.apps.card.v1.Card.CardFixedFooter fixed_footer = 5;
      Returns:
      The fixedFooter.
    • getFixedFooterOrBuilder

      Card.CardFixedFooterOrBuilder getFixedFooterOrBuilder()
       The fixed footer shown at the bottom of this card.
      
       Setting `fixedFooter` without specifying a `primaryButton` or a
       `secondaryButton` causes an error. For Chat apps, you can use fixed footers
       in
       [dialogs](https://developers.google.com/workspace/chat/dialogs), but not
       [card
       messages](https://developers.google.com/workspace/chat/create-messages#create).
      
       [Google Workspace Add-ons and Chat
       apps](https://developers.google.com/workspace/extend):
       
      .google.apps.card.v1.Card.CardFixedFooter fixed_footer = 5;
    • getDisplayStyleValue

      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;
      Returns:
      The enum numeric value on the wire for displayStyle.
    • getDisplayStyle

      Card.DisplayStyle 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;
      Returns:
      The displayStyle.
    • hasPeekCardHeader

      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;
      Returns:
      Whether the peekCardHeader field is set.
    • getPeekCardHeader

      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.
      
       [Google Workspace
       Add-ons](https://developers.google.com/workspace/add-ons):
       
      .google.apps.card.v1.Card.CardHeader peek_card_header = 7;
      Returns:
      The peekCardHeader.
    • getPeekCardHeaderOrBuilder

      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.
      
       [Google Workspace
       Add-ons](https://developers.google.com/workspace/add-ons):
       
      .google.apps.card.v1.Card.CardHeader peek_card_header = 7;