Package com.google.apps.card.v1

Class Button

  • All Implemented Interfaces:
    ButtonOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.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:
    Serialized Form

    • Nested Class Summary

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

      • 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.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.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()
      If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color.
      ColorOrBuilder getColorOrBuilder()
      If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color.
      static Button getDefaultInstance()  
      Button getDefaultInstanceForType()  
      static 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()
      The icon image.
      IconOrBuilder getIconOrBuilder()
      The icon image.
      OnClick getOnClick()
      Required.
      OnClickOrBuilder getOnClickOrBuilder()
      Required.
      com.google.protobuf.Parser<Button> getParserForType()  
      int getSerializedSize()  
      java.lang.String getText()
      The text displayed inside the button.
      com.google.protobuf.ByteString getTextBytes()
      The text displayed inside the button.
      boolean hasColor()
      If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color.
      int hashCode()  
      boolean hasIcon()
      The icon image.
      boolean hasOnClick()
      Required.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      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 java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Button parseDelimitedFrom​(java.io.InputStream input)  
      static Button parseDelimitedFrom​(java.io.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​(java.io.InputStream input)  
      static Button parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Button parseFrom​(java.nio.ByteBuffer data)  
      static Button parseFrom​(java.nio.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

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType

      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        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

    • Method Detail

      • newInstance

        protected java.lang.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()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getText

        public java.lang.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()
         The icon image. 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()
         The icon image. 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()
         The icon image. 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()
         If set, the button is filled with a solid background color and the font
 color changes to maintain contrast with the background color. For example,
 setting a blue background likely results in white text.

 If unset, the image background is white and the font color is blue.

 For red, green, and blue, the value of each field is a `float` number that
 you can express in either of two ways: as a number between 0 and 255
 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents
 the absence of a color and 1 or 255/255 represent the full presence of that
 color on the RGB scale.

 Optionally set `alpha`, which sets a level of transparency using this
 equation:

 ```
 pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
 ```

 For `alpha`, a value of `1` corresponds with a solid color, and a value of
 `0` corresponds with a completely transparent color.

 For example, the following color represents a half transparent red:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
    "alpha": 0.5
 }
 ```
        .google.type.Color color = 3;
        Specified by:
        hasColor in interface ButtonOrBuilder
        Returns:
        Whether the color field is set.

      • getColor

        public Color getColor()
         If set, the button is filled with a solid background color and the font
 color changes to maintain contrast with the background color. For example,
 setting a blue background likely results in white text.

 If unset, the image background is white and the font color is blue.

 For red, green, and blue, the value of each field is a `float` number that
 you can express in either of two ways: as a number between 0 and 255
 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents
 the absence of a color and 1 or 255/255 represent the full presence of that
 color on the RGB scale.

 Optionally set `alpha`, which sets a level of transparency using this
 equation:

 ```
 pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
 ```

 For `alpha`, a value of `1` corresponds with a solid color, and a value of
 `0` corresponds with a completely transparent color.

 For example, the following color represents a half transparent red:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
    "alpha": 0.5
 }
 ```
        .google.type.Color color = 3;
        Specified by:
        getColor in interface ButtonOrBuilder
        Returns:
        The color.

      • getColorOrBuilder

        public ColorOrBuilder getColorOrBuilder()
         If set, the button is filled with a solid background color and the font
 color changes to maintain contrast with the background color. For example,
 setting a blue background likely results in white text.

 If unset, the image background is white and the font color is blue.

 For red, green, and blue, the value of each field is a `float` number that
 you can express in either of two ways: as a number between 0 and 255
 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents
 the absence of a color and 1 or 255/255 represent the full presence of that
 color on the RGB scale.

 Optionally set `alpha`, which sets a level of transparency using this
 equation:

 ```
 pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
 ```

 For `alpha`, a value of `1` corresponds with a solid color, and a value of
 `0` corresponds with a completely transparent color.

 For example, the following color represents a half transparent red:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
    "alpha": 0.5
 }
 ```
        .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 java.lang.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.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Button parseFrom​(java.nio.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​(java.io.InputStream input)
                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static Button parseDelimitedFrom​(java.io.InputStream input)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • 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.GeneratedMessage

      • getDefaultInstanceForType

        public Button 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