Package com.google.apps.card.v1

Class DecoratedText.Builder

  • All Implemented Interfaces:
    DecoratedTextOrBuilder, 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, java.lang.Cloneable
    Enclosing class:
    DecoratedText
    public static final class DecoratedText.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>
implements DecoratedTextOrBuilder
     A widget that displays text with optional decorations such as a label above
 or below the text, an icon in front of the text, a selection widget, or a
 button after the text. For an example in
 Google Chat apps, see [Display text with decorative
 text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements).

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

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>

      • clear

        public DecoratedText.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.GeneratedMessageV3.Builder<DecoratedText.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<DecoratedText.Builder>

      • getDefaultInstanceForType

        public DecoratedText getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public DecoratedText.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>

      • setField

        public DecoratedText.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>

      • clearField

        public DecoratedText.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>

      • clearOneof

        public DecoratedText.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>

      • setRepeatedField

        public DecoratedText.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>

      • addRepeatedField

        public DecoratedText.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>

      • mergeFrom

        public DecoratedText.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<DecoratedText.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,​DecoratedText.Builder>

      • mergeFrom

        public DecoratedText.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.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<DecoratedText.Builder>
        Throws:
        java.io.IOException

      • hasIcon

        @Deprecated
public boolean hasIcon()
        Deprecated.
        google.apps.card.v1.DecoratedText.icon is deprecated. See google/apps/card/v1/card.proto;l=796
         Deprecated in favor of `startIcon`.
        .google.apps.card.v1.Icon icon = 1 [deprecated = true];
        Specified by:
        hasIcon in interface DecoratedTextOrBuilder
        Returns:
        Whether the icon field is set.

      • getIcon

        @Deprecated
public Icon getIcon()
        Deprecated.
        google.apps.card.v1.DecoratedText.icon is deprecated. See google/apps/card/v1/card.proto;l=796
         Deprecated in favor of `startIcon`.
        .google.apps.card.v1.Icon icon = 1 [deprecated = true];
        Specified by:
        getIcon in interface DecoratedTextOrBuilder
        Returns:
        The icon.

      • setIcon

        @Deprecated
public DecoratedText.Builder setIcon​(Icon value)
        Deprecated.
         Deprecated in favor of `startIcon`.
        .google.apps.card.v1.Icon icon = 1 [deprecated = true];

      • setIcon

        @Deprecated
public DecoratedText.Builder setIcon​(Icon.Builder builderForValue)
        Deprecated.
         Deprecated in favor of `startIcon`.
        .google.apps.card.v1.Icon icon = 1 [deprecated = true];

      • mergeIcon

        @Deprecated
public DecoratedText.Builder mergeIcon​(Icon value)
        Deprecated.
         Deprecated in favor of `startIcon`.
        .google.apps.card.v1.Icon icon = 1 [deprecated = true];

      • clearIcon

        @Deprecated
public DecoratedText.Builder clearIcon()
        Deprecated.
         Deprecated in favor of `startIcon`.
        .google.apps.card.v1.Icon icon = 1 [deprecated = true];

      • getIconBuilder

        @Deprecated
public Icon.Builder getIconBuilder()
        Deprecated.
         Deprecated in favor of `startIcon`.
        .google.apps.card.v1.Icon icon = 1 [deprecated = true];

      • hasStartIcon

        public boolean hasStartIcon()
         The icon displayed in front of the text.
        .google.apps.card.v1.Icon start_icon = 12;
        Specified by:
        hasStartIcon in interface DecoratedTextOrBuilder
        Returns:
        Whether the startIcon field is set.

      • getStartIcon

        public Icon getStartIcon()
         The icon displayed in front of the text.
        .google.apps.card.v1.Icon start_icon = 12;
        Specified by:
        getStartIcon in interface DecoratedTextOrBuilder
        Returns:
        The startIcon.

      • setStartIcon

        public DecoratedText.Builder setStartIcon​(Icon value)
         The icon displayed in front of the text.
        .google.apps.card.v1.Icon start_icon = 12;

      • setStartIcon

        public DecoratedText.Builder setStartIcon​(Icon.Builder builderForValue)
         The icon displayed in front of the text.
        .google.apps.card.v1.Icon start_icon = 12;

      • mergeStartIcon

        public DecoratedText.Builder mergeStartIcon​(Icon value)
         The icon displayed in front of the text.
        .google.apps.card.v1.Icon start_icon = 12;

      • clearStartIcon

        public DecoratedText.Builder clearStartIcon()
         The icon displayed in front of the text.
        .google.apps.card.v1.Icon start_icon = 12;

      • getStartIconBuilder

        public Icon.Builder getStartIconBuilder()
         The icon displayed in front of the text.
        .google.apps.card.v1.Icon start_icon = 12;

      • getTopLabel

        public java.lang.String getTopLabel()
         The text that appears above `text`. Always truncates.
        string top_label = 3;
        Specified by:
        getTopLabel in interface DecoratedTextOrBuilder
        Returns:
        The topLabel.

      • getTopLabelBytes

        public com.google.protobuf.ByteString getTopLabelBytes()
         The text that appears above `text`. Always truncates.
        string top_label = 3;
        Specified by:
        getTopLabelBytes in interface DecoratedTextOrBuilder
        Returns:
        The bytes for topLabel.

      • setTopLabel

        public DecoratedText.Builder setTopLabel​(java.lang.String value)
         The text that appears above `text`. Always truncates.
        string top_label = 3;
        Parameters:
        value - The topLabel to set.
        Returns:
        This builder for chaining.

      • clearTopLabel

        public DecoratedText.Builder clearTopLabel()
         The text that appears above `text`. Always truncates.
        string top_label = 3;
        Returns:
        This builder for chaining.

      • setTopLabelBytes

        public DecoratedText.Builder setTopLabelBytes​(com.google.protobuf.ByteString value)
         The text that appears above `text`. Always truncates.
        string top_label = 3;
        Parameters:
        value - The bytes for topLabel to set.
        Returns:
        This builder for chaining.

      • getText

        public java.lang.String getText()
         Required. The primary text.

 Supports simple formatting. 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 text = 4;
        Specified by:
        getText in interface DecoratedTextOrBuilder
        Returns:
        The text.

      • getTextBytes

        public com.google.protobuf.ByteString getTextBytes()
         Required. The primary text.

 Supports simple formatting. 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 text = 4;
        Specified by:
        getTextBytes in interface DecoratedTextOrBuilder
        Returns:
        The bytes for text.

      • setText

        public DecoratedText.Builder setText​(java.lang.String value)
         Required. The primary text.

 Supports simple formatting. 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 text = 4;
        Parameters:
        value - The text to set.
        Returns:
        This builder for chaining.

      • clearText

        public DecoratedText.Builder clearText()
         Required. The primary text.

 Supports simple formatting. 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 text = 4;
        Returns:
        This builder for chaining.

      • setTextBytes

        public DecoratedText.Builder setTextBytes​(com.google.protobuf.ByteString value)
         Required. The primary text.

 Supports simple formatting. 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 text = 4;
        Parameters:
        value - The bytes for text to set.
        Returns:
        This builder for chaining.

      • getWrapText

        public boolean getWrapText()
         The wrap text setting. If `true`, the text wraps and displays on
 multiple lines. Otherwise, the text is truncated.

 Only applies to `text`, not `topLabel` and `bottomLabel`.
        bool wrap_text = 5;
        Specified by:
        getWrapText in interface DecoratedTextOrBuilder
        Returns:
        The wrapText.

      • setWrapText

        public DecoratedText.Builder setWrapText​(boolean value)
         The wrap text setting. If `true`, the text wraps and displays on
 multiple lines. Otherwise, the text is truncated.

 Only applies to `text`, not `topLabel` and `bottomLabel`.
        bool wrap_text = 5;
        Parameters:
        value - The wrapText to set.
        Returns:
        This builder for chaining.

      • clearWrapText

        public DecoratedText.Builder clearWrapText()
         The wrap text setting. If `true`, the text wraps and displays on
 multiple lines. Otherwise, the text is truncated.

 Only applies to `text`, not `topLabel` and `bottomLabel`.
        bool wrap_text = 5;
        Returns:
        This builder for chaining.

      • getBottomLabel

        public java.lang.String getBottomLabel()
         The text that appears below `text`. Always wraps.
        string bottom_label = 6;
        Specified by:
        getBottomLabel in interface DecoratedTextOrBuilder
        Returns:
        The bottomLabel.

      • getBottomLabelBytes

        public com.google.protobuf.ByteString getBottomLabelBytes()
         The text that appears below `text`. Always wraps.
        string bottom_label = 6;
        Specified by:
        getBottomLabelBytes in interface DecoratedTextOrBuilder
        Returns:
        The bytes for bottomLabel.

      • setBottomLabel

        public DecoratedText.Builder setBottomLabel​(java.lang.String value)
         The text that appears below `text`. Always wraps.
        string bottom_label = 6;
        Parameters:
        value - The bottomLabel to set.
        Returns:
        This builder for chaining.

      • clearBottomLabel

        public DecoratedText.Builder clearBottomLabel()
         The text that appears below `text`. Always wraps.
        string bottom_label = 6;
        Returns:
        This builder for chaining.

      • setBottomLabelBytes

        public DecoratedText.Builder setBottomLabelBytes​(com.google.protobuf.ByteString value)
         The text that appears below `text`. Always wraps.
        string bottom_label = 6;
        Parameters:
        value - The bytes for bottomLabel to set.
        Returns:
        This builder for chaining.

      • hasOnClick

        public boolean hasOnClick()
         This action is triggered when users click `topLabel` or `bottomLabel`.
        .google.apps.card.v1.OnClick on_click = 7;
        Specified by:
        hasOnClick in interface DecoratedTextOrBuilder
        Returns:
        Whether the onClick field is set.

      • getOnClick

        public OnClick getOnClick()
         This action is triggered when users click `topLabel` or `bottomLabel`.
        .google.apps.card.v1.OnClick on_click = 7;
        Specified by:
        getOnClick in interface DecoratedTextOrBuilder
        Returns:
        The onClick.

      • setOnClick

        public DecoratedText.Builder setOnClick​(OnClick value)
         This action is triggered when users click `topLabel` or `bottomLabel`.
        .google.apps.card.v1.OnClick on_click = 7;

      • setOnClick

        public DecoratedText.Builder setOnClick​(OnClick.Builder builderForValue)
         This action is triggered when users click `topLabel` or `bottomLabel`.
        .google.apps.card.v1.OnClick on_click = 7;

      • mergeOnClick

        public DecoratedText.Builder mergeOnClick​(OnClick value)
         This action is triggered when users click `topLabel` or `bottomLabel`.
        .google.apps.card.v1.OnClick on_click = 7;

      • clearOnClick

        public DecoratedText.Builder clearOnClick()
         This action is triggered when users click `topLabel` or `bottomLabel`.
        .google.apps.card.v1.OnClick on_click = 7;

      • getOnClickBuilder

        public OnClick.Builder getOnClickBuilder()
         This action is triggered when users click `topLabel` or `bottomLabel`.
        .google.apps.card.v1.OnClick on_click = 7;

      • hasButton

        public boolean hasButton()
         A button that a user can click to trigger an action.
        .google.apps.card.v1.Button button = 8;
        Specified by:
        hasButton in interface DecoratedTextOrBuilder
        Returns:
        Whether the button field is set.

      • getButton

        public Button getButton()
         A button that a user can click to trigger an action.
        .google.apps.card.v1.Button button = 8;
        Specified by:
        getButton in interface DecoratedTextOrBuilder
        Returns:
        The button.

      • setButton

        public DecoratedText.Builder setButton​(Button value)
         A button that a user can click to trigger an action.
        .google.apps.card.v1.Button button = 8;

      • setButton

        public DecoratedText.Builder setButton​(Button.Builder builderForValue)
         A button that a user can click to trigger an action.
        .google.apps.card.v1.Button button = 8;

      • mergeButton

        public DecoratedText.Builder mergeButton​(Button value)
         A button that a user can click to trigger an action.
        .google.apps.card.v1.Button button = 8;

      • clearButton

        public DecoratedText.Builder clearButton()
         A button that a user can click to trigger an action.
        .google.apps.card.v1.Button button = 8;

      • getButtonBuilder

        public Button.Builder getButtonBuilder()
         A button that a user can click to trigger an action.
        .google.apps.card.v1.Button button = 8;

      • hasSwitchControl

        public boolean hasSwitchControl()
         A switch widget that a user can click to change its state and trigger an
 action.
        .google.apps.card.v1.DecoratedText.SwitchControl switch_control = 9;
        Specified by:
        hasSwitchControl in interface DecoratedTextOrBuilder
        Returns:
        Whether the switchControl field is set.

      • setSwitchControl

        public DecoratedText.Builder setSwitchControl​(DecoratedText.SwitchControl value)
         A switch widget that a user can click to change its state and trigger an
 action.
        .google.apps.card.v1.DecoratedText.SwitchControl switch_control = 9;

      • mergeSwitchControl

        public DecoratedText.Builder mergeSwitchControl​(DecoratedText.SwitchControl value)
         A switch widget that a user can click to change its state and trigger an
 action.
        .google.apps.card.v1.DecoratedText.SwitchControl switch_control = 9;

      • clearSwitchControl

        public DecoratedText.Builder clearSwitchControl()
         A switch widget that a user can click to change its state and trigger an
 action.
        .google.apps.card.v1.DecoratedText.SwitchControl switch_control = 9;

      • getSwitchControlBuilder

        public DecoratedText.SwitchControl.Builder getSwitchControlBuilder()
         A switch widget that a user can click to change its state and trigger an
 action.
        .google.apps.card.v1.DecoratedText.SwitchControl switch_control = 9;

      • hasEndIcon

        public boolean hasEndIcon()
         An icon displayed after the text.

 Supports
 [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 and
 [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 icons.
        .google.apps.card.v1.Icon end_icon = 11;
        Specified by:
        hasEndIcon in interface DecoratedTextOrBuilder
        Returns:
        Whether the endIcon field is set.

      • getEndIcon

        public Icon getEndIcon()
         An icon displayed after the text.

 Supports
 [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 and
 [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 icons.
        .google.apps.card.v1.Icon end_icon = 11;
        Specified by:
        getEndIcon in interface DecoratedTextOrBuilder
        Returns:
        The endIcon.

      • setEndIcon

        public DecoratedText.Builder setEndIcon​(Icon value)
         An icon displayed after the text.

 Supports
 [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 and
 [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 icons.
        .google.apps.card.v1.Icon end_icon = 11;

      • setEndIcon

        public DecoratedText.Builder setEndIcon​(Icon.Builder builderForValue)
         An icon displayed after the text.

 Supports
 [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 and
 [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 icons.
        .google.apps.card.v1.Icon end_icon = 11;

      • mergeEndIcon

        public DecoratedText.Builder mergeEndIcon​(Icon value)
         An icon displayed after the text.

 Supports
 [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 and
 [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 icons.
        .google.apps.card.v1.Icon end_icon = 11;

      • clearEndIcon

        public DecoratedText.Builder clearEndIcon()
         An icon displayed after the text.

 Supports
 [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 and
 [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 icons.
        .google.apps.card.v1.Icon end_icon = 11;

      • getEndIconBuilder

        public Icon.Builder getEndIconBuilder()
         An icon displayed after the text.

 Supports
 [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 and
 [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 icons.
        .google.apps.card.v1.Icon end_icon = 11;

      • getEndIconOrBuilder

        public IconOrBuilder getEndIconOrBuilder()
         An icon displayed after the text.

 Supports
 [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
 and
 [custom](https://developers.google.com/workspace/chat/format-messages#customicons)
 icons.
        .google.apps.card.v1.Icon end_icon = 11;
        Specified by:
        getEndIconOrBuilder in interface DecoratedTextOrBuilder

      • setUnknownFields

        public final DecoratedText.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>

      • mergeUnknownFields

        public final DecoratedText.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DecoratedText.Builder>