Package com.google.apps.card.v1

Class Button

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.apps.card.v1.Button
All Implemented Interfaces:
ButtonOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Button extends com.google.protobuf.GeneratedMessageV3 implements ButtonOrBuilder
 A text, icon, or text and icon button that users can click. For an example in
 Google Chat apps, see
 [Add a
 button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).

 To make an image a clickable button, specify an
 [`Image`][google.apps.card.v1.Image] (not an
 [`ImageComponent`][google.apps.card.v1.ImageComponent]) and set an
 `onClick` action.

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Button.Builder
    A text, icon, or text and icon button that users can click.
    static enum 
    Button.Type
    Optional.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALT_TEXT_FIELD_NUMBER
     
    static final int
    COLOR_FIELD_NUMBER
     
    static final int
    DISABLED_FIELD_NUMBER
     
    static final int
    ICON_FIELD_NUMBER
     
    static final int
    ON_CLICK_FIELD_NUMBER
     
    static final int
    TEXT_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAltText()
    The alternative text that's used for accessibility.
    com.google.protobuf.ByteString
    getAltTextBytes()
    The alternative text that's used for accessibility.
    Color
    getColor()
    Optional.
    ColorOrBuilder
    getColorOrBuilder()
    Optional.
    static Button
    getDefaultInstance()
     
    Button
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDisabled()
    If `true`, the button is displayed in an inactive state and doesn't respond to user actions.
    Icon
    getIcon()
    An icon displayed inside the button.
    IconOrBuilder
    getIconOrBuilder()
    An icon displayed inside the button.
    OnClick
    getOnClick()
    Required.
    OnClickOrBuilder
    getOnClickOrBuilder()
    Required.
    com.google.protobuf.Parser<Button>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getText()
    The text displayed inside the button.
    com.google.protobuf.ByteString
    getTextBytes()
    The text displayed inside the button.
    Button.Type
    getType()
    Optional.
    int
    getTypeValue()
    Optional.
    boolean
    hasColor()
    Optional.
    int
    hashCode()
     
    boolean
    hasIcon()
    An icon displayed inside the button.
    boolean
    hasOnClick()
    Required.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Button.Builder
    newBuilder()
     
    static Button.Builder
    newBuilder(Button prototype)
     
    Button.Builder
    newBuilderForType()
     
    protected Button.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Button
    parseDelimitedFrom(InputStream input)
     
    static Button
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Button
    parseFrom(byte[] data)
     
    static Button
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Button
    parseFrom(com.google.protobuf.ByteString data)
     
    static Button
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Button
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Button
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Button
    parseFrom(InputStream input)
     
    static Button
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Button
    parseFrom(ByteBuffer data)
     
    static Button
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Button>
    parser()
     
    Button.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getText

      public String getText()
       The text displayed inside the button.
      string text = 1;
      Specified by:
      getText in interface ButtonOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       The text displayed inside the button.
      string text = 1;
      Specified by:
      getTextBytes in interface ButtonOrBuilder
      Returns:
      The bytes for text.

    • hasIcon

      public boolean hasIcon()
       An icon displayed inside the button. If both `icon` and `text` are set,
 then the icon appears before the text.
      .google.apps.card.v1.Icon icon = 2;
      Specified by:
      hasIcon in interface ButtonOrBuilder
      Returns:
      Whether the icon field is set.

    • getIcon

      public Icon getIcon()
       An icon displayed inside the button. If both `icon` and `text` are set,
 then the icon appears before the text.
      .google.apps.card.v1.Icon icon = 2;
      Specified by:
      getIcon in interface ButtonOrBuilder
      Returns:
      The icon.

    • getIconOrBuilder

      public IconOrBuilder getIconOrBuilder()
       An icon displayed inside the button. If both `icon` and `text` are set,
 then the icon appears before the text.
      .google.apps.card.v1.Icon icon = 2;
      Specified by:
      getIconOrBuilder in interface ButtonOrBuilder

    • hasColor

      public boolean hasColor()
       Optional. The color of the button. If set, the button `type` is set to
 `FILLED` and the color of `text` and `icon` fields are set to a
 contrasting color for readability. For example, if the button color is
 set to blue, any text or icons in the button are set to white.

 To set the button color, specify a value for the `red`, `green`, and `blue`
 fields.
 The value must be a float number between 0 and 1 based on the RGB color
 value, where `0` (0/255) represents the absence of color  and `1` (255/255)
 represents the maximum intensity of the color.

 For example, the following sets the color to red at its maximum intensity:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
 }
 ```

 The `alpha` field is unavailable for button color. If specified, this field
 is ignored.
      .google.type.Color color = 3;
      Specified by:
      hasColor in interface ButtonOrBuilder
      Returns:
      Whether the color field is set.

    • getColor

      public Color getColor()
       Optional. The color of the button. If set, the button `type` is set to
 `FILLED` and the color of `text` and `icon` fields are set to a
 contrasting color for readability. For example, if the button color is
 set to blue, any text or icons in the button are set to white.

 To set the button color, specify a value for the `red`, `green`, and `blue`
 fields.
 The value must be a float number between 0 and 1 based on the RGB color
 value, where `0` (0/255) represents the absence of color  and `1` (255/255)
 represents the maximum intensity of the color.

 For example, the following sets the color to red at its maximum intensity:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
 }
 ```

 The `alpha` field is unavailable for button color. If specified, this field
 is ignored.
      .google.type.Color color = 3;
      Specified by:
      getColor in interface ButtonOrBuilder
      Returns:
      The color.

    • getColorOrBuilder

      public ColorOrBuilder getColorOrBuilder()
       Optional. The color of the button. If set, the button `type` is set to
 `FILLED` and the color of `text` and `icon` fields are set to a
 contrasting color for readability. For example, if the button color is
 set to blue, any text or icons in the button are set to white.

 To set the button color, specify a value for the `red`, `green`, and `blue`
 fields.
 The value must be a float number between 0 and 1 based on the RGB color
 value, where `0` (0/255) represents the absence of color  and `1` (255/255)
 represents the maximum intensity of the color.

 For example, the following sets the color to red at its maximum intensity:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
 }
 ```

 The `alpha` field is unavailable for button color. If specified, this field
 is ignored.
      .google.type.Color color = 3;
      Specified by:
      getColorOrBuilder in interface ButtonOrBuilder

    • hasOnClick

      public boolean hasOnClick()
       Required. The action to perform when a user clicks the button, such as
 opening a hyperlink or running a custom function.
      .google.apps.card.v1.OnClick on_click = 4;
      Specified by:
      hasOnClick in interface ButtonOrBuilder
      Returns:
      Whether the onClick field is set.

    • getOnClick

      public OnClick getOnClick()
       Required. The action to perform when a user clicks the button, such as
 opening a hyperlink or running a custom function.
      .google.apps.card.v1.OnClick on_click = 4;
      Specified by:
      getOnClick in interface ButtonOrBuilder
      Returns:
      The onClick.

    • getOnClickOrBuilder

      public OnClickOrBuilder getOnClickOrBuilder()
       Required. The action to perform when a user clicks the button, such as
 opening a hyperlink or running a custom function.
      .google.apps.card.v1.OnClick on_click = 4;
      Specified by:
      getOnClickOrBuilder in interface ButtonOrBuilder

    • getDisabled

      public boolean getDisabled()
       If `true`, the button is displayed in an inactive state and doesn't respond
 to user actions.
      bool disabled = 5;
      Specified by:
      getDisabled in interface ButtonOrBuilder
      Returns:
      The disabled.

    • getAltText

      public String getAltText()
       The alternative text that's used for accessibility.

 Set descriptive text that lets users know what the button does. For
 example, if a button opens a hyperlink, you might write: "Opens a new
 browser tab and navigates to the Google Chat developer documentation at
 https://developers.google.com/workspace/chat".
      string alt_text = 6;
      Specified by:
      getAltText in interface ButtonOrBuilder
      Returns:
      The altText.

    • getAltTextBytes

      public com.google.protobuf.ByteString getAltTextBytes()
       The alternative text that's used for accessibility.

 Set descriptive text that lets users know what the button does. For
 example, if a button opens a hyperlink, you might write: "Opens a new
 browser tab and navigates to the Google Chat developer documentation at
 https://developers.google.com/workspace/chat".
      string alt_text = 6;
      Specified by:
      getAltTextBytes in interface ButtonOrBuilder
      Returns:
      The bytes for altText.

    • getTypeValue

      public int getTypeValue()
       Optional. The type of a button. If unset, button type defaults to
 `OUTLINED`. If the `color` field is set, the button type is forced to
 `FILLED` and any value set for this field is ignored.
      .google.apps.card.v1.Button.Type type = 7;
      Specified by:
      getTypeValue in interface ButtonOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public Button.Type getType()
       Optional. The type of a button. If unset, button type defaults to
 `OUTLINED`. If the `color` field is set, the button type is forced to
 `FILLED` and any value set for this field is ignored.
      .google.apps.card.v1.Button.Type type = 7;
      Specified by:
      getType in interface ButtonOrBuilder
      Returns:
      The type.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Button parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Button parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Button parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Button parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Button parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Button parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Button parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Button parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Button parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Button parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Button parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Button parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Button.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Button.Builder newBuilder()

    • newBuilder

      public static Button.Builder newBuilder(Button prototype)

    • toBuilder

      public Button.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Button.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Button getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Button> parser()

    • getParserForType

      public com.google.protobuf.Parser<Button> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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