Package com.google.apps.card.v1

Class Card.Section.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Card.Section.Builder>
com.google.apps.card.v1.Card.Section.Builder
All Implemented Interfaces:
Card.SectionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Card.Section
public static final class Card.Section.Builder extends com.google.protobuf.GeneratedMessage.Builder<Card.Section.Builder> implements Card.SectionOrBuilder
 A section contains a collection of widgets that are rendered
 vertically in the order that they're specified.

 [Google Workspace add-ons and Chat
 apps](https://developers.google.com/workspace/extend):
Protobuf type google.apps.card.v1.Card.Section

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Card.Section.Builder>

    • clear

      public Card.Section.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Card.Section.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Card.Section.Builder>

    • getDefaultInstanceForType

      public Card.Section getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Card.Section build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Card.Section buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Card.Section.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Card.Section.Builder>

    • mergeFrom

      public Card.Section.Builder mergeFrom(Card.Section other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Card.Section.Builder>

    • mergeFrom

      public Card.Section.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Card.Section.Builder>
      Throws:
      IOException

    • getHeader

      public String getHeader()
       Text that appears at the top of a section.
 Supports simple HTML formatted text. For more information
 about formatting text, see
 [Formatting text in Google Chat
 apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
 and
 [Formatting
 text in Google Workspace
 add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
      string header = 1;
      Specified by:
      getHeader in interface Card.SectionOrBuilder
      Returns:
      The header.

    • getHeaderBytes

      public com.google.protobuf.ByteString getHeaderBytes()
       Text that appears at the top of a section.
 Supports simple HTML formatted text. For more information
 about formatting text, see
 [Formatting text in Google Chat
 apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
 and
 [Formatting
 text in Google Workspace
 add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
      string header = 1;
      Specified by:
      getHeaderBytes in interface Card.SectionOrBuilder
      Returns:
      The bytes for header.

    • setHeader

      public Card.Section.Builder setHeader(String value)
       Text that appears at the top of a section.
 Supports simple HTML formatted text. For more information
 about formatting text, see
 [Formatting text in Google Chat
 apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
 and
 [Formatting
 text in Google Workspace
 add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
      string header = 1;
      Parameters:
      value - The header to set.
      Returns:
      This builder for chaining.

    • clearHeader

      public Card.Section.Builder clearHeader()
       Text that appears at the top of a section.
 Supports simple HTML formatted text. For more information
 about formatting text, see
 [Formatting text in Google Chat
 apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
 and
 [Formatting
 text in Google Workspace
 add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
      string header = 1;
      Returns:
      This builder for chaining.

    • setHeaderBytes

      public Card.Section.Builder setHeaderBytes(com.google.protobuf.ByteString value)
       Text that appears at the top of a section.
 Supports simple HTML formatted text. For more information
 about formatting text, see
 [Formatting text in Google Chat
 apps](https://developers.google.com/workspace/chat/format-messages#card-formatting)
 and
 [Formatting
 text in Google Workspace
 add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
      string header = 1;
      Parameters:
      value - The bytes for header to set.
      Returns:
      This builder for chaining.

    • getWidgetsList

      public List<Widget> getWidgetsList()
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;
      Specified by:
      getWidgetsList in interface Card.SectionOrBuilder

    • getWidgetsCount

      public int getWidgetsCount()
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;
      Specified by:
      getWidgetsCount in interface Card.SectionOrBuilder

    • getWidgets

      public Widget getWidgets(int index)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;
      Specified by:
      getWidgets in interface Card.SectionOrBuilder

    • setWidgets

      public Card.Section.Builder setWidgets(int index, Widget value)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • setWidgets

      public Card.Section.Builder setWidgets(int index, Widget.Builder builderForValue)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • addWidgets

      public Card.Section.Builder addWidgets(Widget value)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • addWidgets

      public Card.Section.Builder addWidgets(int index, Widget value)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • addWidgets

      public Card.Section.Builder addWidgets(Widget.Builder builderForValue)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • addWidgets

      public Card.Section.Builder addWidgets(int index, Widget.Builder builderForValue)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • addAllWidgets

      public Card.Section.Builder addAllWidgets(Iterable<? extends Widget> values)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • clearWidgets

      public Card.Section.Builder clearWidgets()
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • removeWidgets

      public Card.Section.Builder removeWidgets(int index)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • getWidgetsBuilder

      public Widget.Builder getWidgetsBuilder(int index)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • getWidgetsOrBuilder

      public WidgetOrBuilder getWidgetsOrBuilder(int index)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;
      Specified by:
      getWidgetsOrBuilder in interface Card.SectionOrBuilder

    • getWidgetsOrBuilderList

      public List<? extends WidgetOrBuilder> getWidgetsOrBuilderList()
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;
      Specified by:
      getWidgetsOrBuilderList in interface Card.SectionOrBuilder

    • addWidgetsBuilder

      public Widget.Builder addWidgetsBuilder()
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • addWidgetsBuilder

      public Widget.Builder addWidgetsBuilder(int index)
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • getWidgetsBuilderList

      public List<Widget.Builder> getWidgetsBuilderList()
       All the widgets in the section.
 Must contain at least one widget.
      repeated .google.apps.card.v1.Widget widgets = 2;

    • getCollapsible

      public boolean getCollapsible()
       Indicates whether this section is collapsible.

 Collapsible sections hide some or all widgets, but users can expand the
 section to reveal the hidden widgets by clicking **Show more**. Users
 can hide the widgets again by clicking **Show less**.

 To determine which widgets are hidden, specify
 `uncollapsibleWidgetsCount`.
      bool collapsible = 5;
      Specified by:
      getCollapsible in interface Card.SectionOrBuilder
      Returns:
      The collapsible.

    • setCollapsible

      public Card.Section.Builder setCollapsible(boolean value)
       Indicates whether this section is collapsible.

 Collapsible sections hide some or all widgets, but users can expand the
 section to reveal the hidden widgets by clicking **Show more**. Users
 can hide the widgets again by clicking **Show less**.

 To determine which widgets are hidden, specify
 `uncollapsibleWidgetsCount`.
      bool collapsible = 5;
      Parameters:
      value - The collapsible to set.
      Returns:
      This builder for chaining.

    • clearCollapsible

      public Card.Section.Builder clearCollapsible()
       Indicates whether this section is collapsible.

 Collapsible sections hide some or all widgets, but users can expand the
 section to reveal the hidden widgets by clicking **Show more**. Users
 can hide the widgets again by clicking **Show less**.

 To determine which widgets are hidden, specify
 `uncollapsibleWidgetsCount`.
      bool collapsible = 5;
      Returns:
      This builder for chaining.

    • getUncollapsibleWidgetsCount

      public int getUncollapsibleWidgetsCount()
       The number of uncollapsible widgets which remain visible even when a
 section is collapsed.

 For example, when a section
 contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`,
 the first two widgets are always shown and the last three are collapsed
 by default. The `uncollapsibleWidgetsCount` is taken into account only
 when `collapsible` is `true`.
      int32 uncollapsible_widgets_count = 6;
      Specified by:
      getUncollapsibleWidgetsCount in interface Card.SectionOrBuilder
      Returns:
      The uncollapsibleWidgetsCount.

    • setUncollapsibleWidgetsCount

      public Card.Section.Builder setUncollapsibleWidgetsCount(int value)
       The number of uncollapsible widgets which remain visible even when a
 section is collapsed.

 For example, when a section
 contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`,
 the first two widgets are always shown and the last three are collapsed
 by default. The `uncollapsibleWidgetsCount` is taken into account only
 when `collapsible` is `true`.
      int32 uncollapsible_widgets_count = 6;
      Parameters:
      value - The uncollapsibleWidgetsCount to set.
      Returns:
      This builder for chaining.

    • clearUncollapsibleWidgetsCount

      public Card.Section.Builder clearUncollapsibleWidgetsCount()
       The number of uncollapsible widgets which remain visible even when a
 section is collapsed.

 For example, when a section
 contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`,
 the first two widgets are always shown and the last three are collapsed
 by default. The `uncollapsibleWidgetsCount` is taken into account only
 when `collapsible` is `true`.
      int32 uncollapsible_widgets_count = 6;
      Returns:
      This builder for chaining.

    • hasCollapseControl

      public boolean hasCollapseControl()
       Optional. Define the expand and collapse button of the section.
 This button will be shown only if the section is collapsible.
 If this field isn't set, the default button is used.
      .google.apps.card.v1.CollapseControl collapse_control = 8;
      Specified by:
      hasCollapseControl in interface Card.SectionOrBuilder
      Returns:
      Whether the collapseControl field is set.

    • getCollapseControl

      public CollapseControl getCollapseControl()
       Optional. Define the expand and collapse button of the section.
 This button will be shown only if the section is collapsible.
 If this field isn't set, the default button is used.
      .google.apps.card.v1.CollapseControl collapse_control = 8;
      Specified by:
      getCollapseControl in interface Card.SectionOrBuilder
      Returns:
      The collapseControl.

    • setCollapseControl

      public Card.Section.Builder setCollapseControl(CollapseControl value)
       Optional. Define the expand and collapse button of the section.
 This button will be shown only if the section is collapsible.
 If this field isn't set, the default button is used.
      .google.apps.card.v1.CollapseControl collapse_control = 8;

    • setCollapseControl

      public Card.Section.Builder setCollapseControl(CollapseControl.Builder builderForValue)
       Optional. Define the expand and collapse button of the section.
 This button will be shown only if the section is collapsible.
 If this field isn't set, the default button is used.
      .google.apps.card.v1.CollapseControl collapse_control = 8;

    • mergeCollapseControl

      public Card.Section.Builder mergeCollapseControl(CollapseControl value)
       Optional. Define the expand and collapse button of the section.
 This button will be shown only if the section is collapsible.
 If this field isn't set, the default button is used.
      .google.apps.card.v1.CollapseControl collapse_control = 8;

    • clearCollapseControl

      public Card.Section.Builder clearCollapseControl()
       Optional. Define the expand and collapse button of the section.
 This button will be shown only if the section is collapsible.
 If this field isn't set, the default button is used.
      .google.apps.card.v1.CollapseControl collapse_control = 8;

    • getCollapseControlBuilder

      public CollapseControl.Builder getCollapseControlBuilder()
       Optional. Define the expand and collapse button of the section.
 This button will be shown only if the section is collapsible.
 If this field isn't set, the default button is used.
      .google.apps.card.v1.CollapseControl collapse_control = 8;

    • getCollapseControlOrBuilder

      public CollapseControlOrBuilder getCollapseControlOrBuilder()
       Optional. Define the expand and collapse button of the section.
 This button will be shown only if the section is collapsible.
 If this field isn't set, the default button is used.
      .google.apps.card.v1.CollapseControl collapse_control = 8;
      Specified by:
      getCollapseControlOrBuilder in interface Card.SectionOrBuilder