Package com.google.apps.card.v1

Interface DecoratedTextOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DecoratedText, DecoratedText.Builder
public interface DecoratedTextOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasIcon

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

    • getIcon

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

    • getIconOrBuilder

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

    • hasStartIcon

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

    • getStartIcon

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

    • getStartIconOrBuilder

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

    • getStartIconVerticalAlignmentValue

      int getStartIconVerticalAlignmentValue()
       Optional. Vertical alignment of the start icon. If not set, the icon
 will be vertically centered.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.Widget.VerticalAlignment start_icon_vertical_alignment = 13;
      Returns:
      The enum numeric value on the wire for startIconVerticalAlignment.

    • getStartIconVerticalAlignment

      Widget.VerticalAlignment getStartIconVerticalAlignment()
       Optional. Vertical alignment of the start icon. If not set, the icon
 will be vertically centered.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.Widget.VerticalAlignment start_icon_vertical_alignment = 13;
      Returns:
      The startIconVerticalAlignment.

    • getTopLabel

      String getTopLabel()
       The text that appears above `text`. Always truncates.
      string top_label = 3;
      Returns:
      The topLabel.

    • getTopLabelBytes

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

    • hasTopLabelText

      boolean hasTopLabelText()
       `TextParagraph` equivalent of `top_label`. Always truncates. Allows for
 more complex formatting than `top_label`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph top_label_text = 17;
      Returns:
      Whether the topLabelText field is set.

    • getTopLabelText

      TextParagraph getTopLabelText()
       `TextParagraph` equivalent of `top_label`. Always truncates. Allows for
 more complex formatting than `top_label`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph top_label_text = 17;
      Returns:
      The topLabelText.

    • getTopLabelTextOrBuilder

      TextParagraphOrBuilder getTopLabelTextOrBuilder()
       `TextParagraph` equivalent of `top_label`. Always truncates. Allows for
 more complex formatting than `top_label`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph top_label_text = 17;

    • getText

      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;
      Returns:
      The text.

    • getTextBytes

      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;
      Returns:
      The bytes for text.

    • hasContentText

      boolean hasContentText()
       `TextParagraph` equivalent of `text`. Allows for more complex formatting
 than `text`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph content_text = 18;
      Returns:
      Whether the contentText field is set.

    • getContentText

      TextParagraph getContentText()
       `TextParagraph` equivalent of `text`. Allows for more complex formatting
 than `text`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph content_text = 18;
      Returns:
      The contentText.

    • getContentTextOrBuilder

      TextParagraphOrBuilder getContentTextOrBuilder()
       `TextParagraph` equivalent of `text`. Allows for more complex formatting
 than `text`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph content_text = 18;

    • getWrapText

      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;
      Returns:
      The wrapText.

    • getBottomLabel

      String getBottomLabel()
       The text that appears below `text`. Always wraps.
      string bottom_label = 6;
      Returns:
      The bottomLabel.

    • getBottomLabelBytes

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

    • hasBottomLabelText

      boolean hasBottomLabelText()
       `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for
 more complex formatting than `bottom_label`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph bottom_label_text = 19;
      Returns:
      Whether the bottomLabelText field is set.

    • getBottomLabelText

      TextParagraph getBottomLabelText()
       `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for
 more complex formatting than `bottom_label`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph bottom_label_text = 19;
      Returns:
      The bottomLabelText.

    • getBottomLabelTextOrBuilder

      TextParagraphOrBuilder getBottomLabelTextOrBuilder()
       `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for
 more complex formatting than `bottom_label`.

 [Google Chat apps](https://developers.google.com/workspace/chat):
      .google.apps.card.v1.TextParagraph bottom_label_text = 19;

    • hasOnClick

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

    • getOnClick

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

    • getOnClickOrBuilder

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

    • hasButton

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

    • getButton

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

    • getButtonOrBuilder

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

    • hasSwitchControl

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

    • getSwitchControl

      DecoratedText.SwitchControl getSwitchControl()
       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;
      Returns:
      The switchControl.

    • getSwitchControlOrBuilder

      DecoratedText.SwitchControlOrBuilder getSwitchControlOrBuilder()
       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

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

    • getEndIcon

      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;
      Returns:
      The endIcon.

    • getEndIconOrBuilder

      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;

    • getControlCase

      DecoratedText.ControlCase getControlCase()