- 2.61.3 (latest)
- 2.61.2
- 2.60.0
- 2.59.2
- 2.58.0
- 2.57.0
- 2.56.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.1
- 2.49.0
- 2.48.0
- 2.46.0
- 2.45.1
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.1
- 2.38.0
- 2.37.1
- 2.36.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.1
- 2.24.0
- 2.23.1
- 2.22.1
- 2.21.1
- 2.15.0
- 2.14.3
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.6
- 2.8.4
- 2.7.4
public final class Button extends GeneratedMessageV3 implements ButtonOrBuilderA 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 > ButtonImplements
ButtonOrBuilderStatic 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 |
|
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 |
|
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()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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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() 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 |
| |