Class Button (2.63.1) 

public final class Button extends 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.

To make an image a clickable button, specify an Image (not an ImageComponent) and set an onClick action.

Google Workspace add-ons and Chat apps:

Protobuf type google.apps.card.v1.Button

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Button

Implements

ButtonOrBuilder

Static Fields

ALT_TEXT_FIELD_NUMBER

public static final int ALT_TEXT_FIELD_NUMBER
Field Value
Type Description
int

COLOR_FIELD_NUMBER

public static final int COLOR_FIELD_NUMBER
Field Value
Type Description
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
Type Description
int

ICON_FIELD_NUMBER

public static final int ICON_FIELD_NUMBER
Field Value
Type Description
int

ON_CLICK_FIELD_NUMBER

public static final int ON_CLICK_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Button getDefaultInstance()
Returns
Type Description
Button

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Button.Builder newBuilder()
Returns
Type Description
Button.Builder

newBuilder(Button prototype)

public static Button.Builder newBuilder(Button prototype)
Parameter
Name Description
prototype Button
Returns
Type Description
Button.Builder

parseDelimitedFrom(InputStream input)

public static Button parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Button
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Button parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Button
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Button parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Button
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Button
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Button parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Button
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Button
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Button parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Button
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Button
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Button parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Button
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Button
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Button parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Button
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Button
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Button> parser()
Returns
Type Description
Parser<Button>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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;

Returns
Type Description
String

The altText.

getAltTextBytes()

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

Returns
Type Description
ByteString

The bytes for altText.

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;

Returns
Type Description
Color

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;

Returns
Type Description
ColorOrBuilder

getDefaultInstanceForType()

public Button getDefaultInstanceForType()
Returns
Type Description
Button

getDisabled()

public boolean getDisabled()

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

bool disabled = 5;

Returns
Type Description
boolean

The disabled.

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;

Returns
Type Description
Icon

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;

Returns
Type Description
IconOrBuilder

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;

Returns
Type Description
OnClick

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;

Returns
Type Description
OnClickOrBuilder

getParserForType()

public Parser<Button> getParserForType()
Returns
Type Description
Parser<Button>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getText()

public String getText()

The text displayed inside the button.

string text = 1;

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

The text displayed inside the button.

string text = 1;

Returns
Type Description
ByteString

The bytes for text.

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;

Returns
Type Description
Button.Type

The type.

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;

Returns
Type Description
int

The enum numeric value on the wire for type.

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;

Returns
Type Description
boolean

Whether the color field is set.

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;

Returns
Type Description
boolean

Whether the icon field is set.

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;

Returns
Type Description
boolean

Whether the onClick field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Button.Builder newBuilderForType()
Returns
Type Description
Button.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Button.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Button.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Button.Builder toBuilder()
Returns
Type Description
Button.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException