t

com.google.apps.card.v1

CardOrBuilder

trait CardOrBuilder extends MessageOrBuilder

Source
CardOrBuilder.java
Linear Supertypes
MessageOrBuilder, MessageLiteOrBuilder, AnyRef, Any
Known Subclasses
Card
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CardOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  2. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  3. abstract def getCardActions(index: Int): CardAction

    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"
      }
    }
  }
]
```


    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;

  4. abstract def getCardActionsCount(): Int

    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"
      }
    }
  }
]
```


    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;

  5. abstract def getCardActionsList(): List[CardAction]

    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"
      }
    }
  }
]
```


    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;

  6. abstract def getCardActionsOrBuilder(index: Int): CardActionOrBuilder

    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"
      }
    }
  }
]
```


    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;

  7. abstract def getCardActionsOrBuilderList(): List[_ <: CardActionOrBuilder]

    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"
      }
    }
  }
]
```


    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;

  8. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  9. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  10. abstract def getDisplayStyle(): DisplayStyle

    In Google Workspace Add-ons, sets the display properties of the
`peekCardHeader`.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):


    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.

  11. abstract def getDisplayStyleValue(): Int

    In Google Workspace Add-ons, sets the display properties of the
`peekCardHeader`.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):


    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.

  12. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  13. abstract def getFixedFooter(): CardFixedFooter

    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):


    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.

  14. abstract def getFixedFooterOrBuilder(): CardFixedFooterOrBuilder

    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):


    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;

  15. abstract def getHeader(): CardHeader

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


    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.

  16. abstract def getHeaderOrBuilder(): CardHeaderOrBuilder

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


    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;

  17. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  18. abstract def getName(): String

    Name of the card. Used as a card identifier in card navigation.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):


    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.

  19. abstract def getNameBytes(): ByteString

    Name of the card. Used as a card identifier in card navigation.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):


    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.

  20. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  21. abstract def getPeekCardHeader(): CardHeader

    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):


    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.

  22. abstract def getPeekCardHeaderOrBuilder(): CardHeaderOrBuilder

    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):


    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;

  23. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  24. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  25. abstract def getSectionDividerStyle(): DividerStyle

    The divider style between sections.


    The divider style between sections.

    .google.apps.card.v1.Card.DividerStyle section_divider_style = 9;

    returns

    The sectionDividerStyle.

  26. abstract def getSectionDividerStyleValue(): Int

    The divider style between sections.


    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.

  27. abstract def getSections(index: Int): Section

    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).


    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;

  28. abstract def getSectionsCount(): Int

    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).


    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;

  29. abstract def getSectionsList(): List[Section]

    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).


    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;

  30. abstract def getSectionsOrBuilder(index: Int): SectionOrBuilder

    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).


    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;

  31. abstract def getSectionsOrBuilderList(): List[_ <: SectionOrBuilder]

    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).


    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;

  32. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  33. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  34. abstract def hasFixedFooter(): Boolean

    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):


    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.

  35. abstract def hasHeader(): Boolean

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


    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.

  36. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  37. abstract def hasPeekCardHeader(): 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.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):


    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.

  38. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped