c

com.google.apps.card.v1

DecoratedText

final class DecoratedText extends GeneratedMessageV3 with 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

Source
DecoratedText.java
Linear Supertypes
DecoratedTextOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DecoratedText
  2. DecoratedTextOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    DecoratedText → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. def getBottomLabel(): String

    The text that appears below `text`. Always wraps.


    The text that appears below `text`. Always wraps.

    string bottom_label = 6;

    returns

    The bottomLabel.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  12. def getBottomLabelBytes(): ByteString

    The text that appears below `text`. Always wraps.


    The text that appears below `text`. Always wraps.

    string bottom_label = 6;

    returns

    The bytes for bottomLabel.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  13. def getButton(): Button

    A button that a user can click to trigger an action.


    A button that a user can click to trigger an action.

    .google.apps.card.v1.Button button = 8;

    returns

    The button.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  14. def getButtonOrBuilder(): ButtonOrBuilder

    A button that a user can click to trigger an action.


    A button that a user can click to trigger an action.

    .google.apps.card.v1.Button button = 8;

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getControlCase(): ControlCase
    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
  17. def getDefaultInstanceForType(): DecoratedText
    Definition Classes
    DecoratedText → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  18. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  19. def getEndIcon(): Icon

    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.


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  20. def getEndIconOrBuilder(): IconOrBuilder

    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.


    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;

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  21. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  22. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  23. def getOnClick(): OnClick

    This action is triggered when users click `topLabel` or `bottomLabel`.


    This action is triggered when users click `topLabel` or `bottomLabel`.

    .google.apps.card.v1.OnClick on_click = 7;

    returns

    The onClick.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  24. def getOnClickOrBuilder(): OnClickOrBuilder

    This action is triggered when users click `topLabel` or `bottomLabel`.


    This action is triggered when users click `topLabel` or `bottomLabel`.

    .google.apps.card.v1.OnClick on_click = 7;

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  25. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  26. def getParserForType(): Parser[DecoratedText]
    Definition Classes
    DecoratedText → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  27. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  28. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  29. def getSerializedSize(): Int
    Definition Classes
    DecoratedText → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  30. def getStartIcon(): Icon

    The icon displayed in front of the text.


    The icon displayed in front of the text.

    .google.apps.card.v1.Icon start_icon = 12;

    returns

    The startIcon.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  31. def getStartIconOrBuilder(): IconOrBuilder

    The icon displayed in front of the text.


    The icon displayed in front of the text.

    .google.apps.card.v1.Icon start_icon = 12;

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  32. def getSwitchControl(): SwitchControl

    A switch widget that a user can click to change its state and trigger an
action.


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  33. def getSwitchControlOrBuilder(): SwitchControlOrBuilder

    A switch widget that a user can click to change its state and trigger an
action.


    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;

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  34. def getText(): String

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


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  35. def getTextBytes(): ByteString

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


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  36. def getTopLabel(): String

    The text that appears above `text`. Always truncates.


    The text that appears above `text`. Always truncates.

    string top_label = 3;

    returns

    The topLabel.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  37. def getTopLabelBytes(): ByteString

    The text that appears above `text`. Always truncates.


    The text that appears above `text`. Always truncates.

    string top_label = 3;

    returns

    The bytes for topLabel.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  38. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  39. def getWrapText(): Boolean

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


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  40. def hasButton(): Boolean

    A button that a user can click to trigger an action.


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  41. def hasEndIcon(): Boolean

    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.


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  42. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  43. def hasOnClick(): Boolean

    This action is triggered when users click `topLabel` or `bottomLabel`.


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  44. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  45. def hasStartIcon(): Boolean

    The icon displayed in front of the text.


    The icon displayed in front of the text.

    .google.apps.card.v1.Icon start_icon = 12;

    returns

    Whether the startIcon field is set.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  46. def hasSwitchControl(): Boolean

    A switch widget that a user can click to change its state and trigger an
action.


    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.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override()
  47. def hashCode(): Int
    Definition Classes
    DecoratedText → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  48. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    DecoratedText → GeneratedMessageV3
    Annotations
    @Override()
  49. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  50. final def isInitialized(): Boolean
    Definition Classes
    DecoratedText → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    DecoratedText → GeneratedMessageV3
    Annotations
    @Override()
  55. def newBuilderForType(): Builder
    Definition Classes
    DecoratedText → Message → MessageLite
    Annotations
    @Override()
  56. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  57. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    DecoratedText → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  61. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  62. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  63. def toBuilder(): Builder
    Definition Classes
    DecoratedText → Message → MessageLite
    Annotations
    @Override()
  64. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  65. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  66. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  70. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  71. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  72. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    DecoratedText → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  73. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getIcon(): Icon

    Deprecated in favor of `startIcon`.


    Deprecated in favor of `startIcon`.

    .google.apps.card.v1.Icon icon = 1 [deprecated = true];

    returns

    The icon.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  2. def getIconOrBuilder(): IconOrBuilder

    Deprecated in favor of `startIcon`.


    Deprecated in favor of `startIcon`.

    .google.apps.card.v1.Icon icon = 1 [deprecated = true];

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  3. def hasIcon(): Boolean

    Deprecated in favor of `startIcon`.


    Deprecated in favor of `startIcon`.

    .google.apps.card.v1.Icon icon = 1 [deprecated = true];

    returns

    Whether the icon field is set.

    Definition Classes
    DecoratedText → DecoratedTextOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  4. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from DecoratedTextOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped