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

Source
Button.java
Linear Supertypes
ButtonOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Button
  2. ButtonOrBuilder
  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
    Button → 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 getAltText(): String

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


    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;

    returns

    The altText.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  12. def getAltTextBytes(): ByteString

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


    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;

    returns

    The bytes for altText.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getColor(): Color

    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.


    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;

    returns

    The color.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  15. def getColorOrBuilder(): ColorOrBuilder

    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.


    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;

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  16. def getDefaultInstanceForType(): Button
    Definition Classes
    Button → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  17. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  18. def getDisabled(): Boolean

    If `true`, the button is displayed in an inactive state and doesn't respond
to user actions.


    If `true`, the button is displayed in an inactive state and doesn't respond
to user actions.

    bool disabled = 5;

    returns

    The disabled.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  19. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  20. def getIcon(): Icon

    An icon displayed inside the button. If both `icon` and `text` are set,
then the icon appears before the text.


    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;

    returns

    The icon.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  21. def getIconOrBuilder(): IconOrBuilder

    An icon displayed inside the button. If both `icon` and `text` are set,
then the icon appears before the text.


    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;

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  22. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  23. def getOnClick(): OnClick

    Required. The action to perform when a user clicks the button, such as
opening a hyperlink or running a custom function.


    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;

    returns

    The onClick.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  24. def getOnClickOrBuilder(): OnClickOrBuilder

    Required. The action to perform when a user clicks the button, such as
opening a hyperlink or running a custom function.


    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;

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  25. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  26. def getParserForType(): Parser[Button]
    Definition Classes
    Button → 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
    Button → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  30. def getText(): String

    The text displayed inside the button.


    The text displayed inside the button.

    string text = 1;

    returns

    The text.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  31. def getTextBytes(): ByteString

    The text displayed inside the button.


    The text displayed inside the button.

    string text = 1;

    returns

    The bytes for text.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  32. def getType(): Type

    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.


    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;

    returns

    The type.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  33. def getTypeValue(): Int

    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.


    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;

    returns

    The enum numeric value on the wire for type.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  34. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  35. def hasColor(): Boolean

    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.


    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;

    returns

    Whether the color field is set.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  36. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  37. def hasIcon(): Boolean

    An icon displayed inside the button. If both `icon` and `text` are set,
then the icon appears before the text.


    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;

    returns

    Whether the icon field is set.

    Definition Classes
    Button → ButtonOrBuilder
    Annotations
    @Override()
  38. def hasOnClick(): Boolean

    Required. The action to perform when a user clicks the button, such as
opening a hyperlink or running a custom function.


    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;

    returns

    Whether the onClick field is set.

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

Deprecated Value Members

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

Inherited from ButtonOrBuilder

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