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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALT_TEXT_FIELD_NUMBER
public static final int ALT_TEXT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int COLOR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DISABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ICON_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
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
public static Button getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Button.Builder newBuilder()
public static Button.Builder newBuilder(Button prototype)
| Parameter |
|---|
| Name | Description |
prototype | Button
|
public static Button parseDelimitedFrom(InputStream input)
public static Button parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Button parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Button parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Button parseFrom(ByteString data)
public static Button parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Button parseFrom(CodedInputStream input)
public static Button parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Button parseFrom(InputStream input)
public static Button parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Button parseFrom(ByteBuffer data)
public static Button parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Button> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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 |
|---|
| 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/chat".
string alt_text = 6;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for altText.
|
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 |
com.google.type.Color | The color.
|
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 |
com.google.type.ColorOrBuilder | |
public Button getDefaultInstanceForType()
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.
|
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.
|
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;
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.
|
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;
public Parser<Button> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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.
|
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.
|
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.
|
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.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Button.Builder newBuilderForType()
protected Button.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Button.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
