Class Button (0.1.0)

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 Button list.

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

Implements

ButtonOrBuilder

Static Fields

ALT_TEXT_FIELD_NUMBER

public static final int ALT_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

COLOR_FIELD_NUMBER

public static final int COLOR_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
TypeDescription
int

ICON_FIELD_NUMBER

public static final int ICON_FIELD_NUMBER
Field Value
TypeDescription
int

ON_CLICK_FIELD_NUMBER

public static final int ON_CLICK_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Button getDefaultInstance()
Returns
TypeDescription
Button

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Button.Builder newBuilder()
Returns
TypeDescription
Button.Builder

newBuilder(Button prototype)

public static Button.Builder newBuilder(Button prototype)
Parameter
NameDescription
prototypeButton
Returns
TypeDescription
Button.Builder

parseDelimitedFrom(InputStream input)

public static Button parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Button
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Button parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Button
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Button parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Button
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Button
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Button parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Button
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Button
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Button parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Button
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Button
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Button parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Button
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Button
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Button parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Button
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Button parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Button
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Button> parser()
Returns
TypeDescription
Parser<Button>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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/chat".

string alt_text = 6;

Returns
TypeDescription
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/chat".

string alt_text = 6;

Returns
TypeDescription
ByteString

The bytes for altText.

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;

Returns
TypeDescription
com.google.type.Color

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;

Returns
TypeDescription
com.google.type.ColorOrBuilder

getDefaultInstanceForType()

public Button getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
boolean

The disabled.

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;

Returns
TypeDescription
Icon

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;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
OnClickOrBuilder

getParserForType()

public Parser<Button> getParserForType()
Returns
TypeDescription
Parser<Button>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getText()

public String getText()

The text displayed inside the button.

string text = 1;

Returns
TypeDescription
String

The text.

getTextBytes()

public ByteString getTextBytes()

The text displayed inside the button.

string text = 1;

Returns
TypeDescription
ByteString

The bytes for text.

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;

Returns
TypeDescription
boolean

Whether the color field is set.

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;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the onClick field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Button.Builder newBuilderForType()
Returns
TypeDescription
Button.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Button.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Button.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Button.Builder toBuilder()
Returns
TypeDescription
Button.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException