public static final class Button.Builder extends GeneratedMessageV3.Builder<Button.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Button.BuilderImplements
ButtonOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Button.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
build()
public Button build()| Returns | |
|---|---|
| Type | Description |
Button |
|
buildPartial()
public Button buildPartial()| Returns | |
|---|---|
| Type | Description |
Button |
|
clear()
public Button.Builder clear()| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
clearAltText()
public Button.Builder clearAltText()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 |
Button.Builder |
This builder for chaining. |
clearColor()
public Button.Builder clearColor()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 |
Button.Builder |
|
clearDisabled()
public Button.Builder clearDisabled() If true, the button is displayed in an inactive state and doesn't respond
to user actions.
bool disabled = 5;
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Button.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
clearIcon()
public Button.Builder clearIcon() 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 |
Button.Builder |
|
clearOnClick()
public Button.Builder clearOnClick()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 |
Button.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Button.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
clearText()
public Button.Builder clearText()The text displayed inside the button.
string text = 1;
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
This builder for chaining. |
clone()
public Button.Builder clone()| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
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. |
getColorBuilder()
public Color.Builder getColorBuilder()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.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getIconBuilder()
public Icon.Builder getIconBuilder() 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.Builder |
|
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. |
getOnClickBuilder()
public OnClick.Builder getOnClickBuilder()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.Builder |
|
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 |
|
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 |
boolean |
Whether the onClick field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeColor(Color value)
public Button.Builder mergeColor(Color value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Color |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
mergeFrom(Button other)
public Button.Builder mergeFrom(Button other)| Parameter | |
|---|---|
| Name | Description |
other |
Button |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Button.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Button.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
mergeIcon(Icon value)
public Button.Builder mergeIcon(Icon value) The icon image. If both icon and text are set, then the icon appears
before the text.
.google.apps.card.v1.Icon icon = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Icon |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
mergeOnClick(OnClick value)
public Button.Builder mergeOnClick(OnClick value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
OnClick |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Button.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setAltText(String value)
public Button.Builder setAltText(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe altText to set. |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
This builder for chaining. |
setAltTextBytes(ByteString value)
public Button.Builder setAltTextBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for altText to set. |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
This builder for chaining. |
setColor(Color value)
public Button.Builder setColor(Color value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Color |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setColor(Color.Builder builderForValue)
public Button.Builder setColor(Color.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Color.Builder |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setDisabled(boolean value)
public Button.Builder setDisabled(boolean value) If true, the button is displayed in an inactive state and doesn't respond
to user actions.
bool disabled = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe disabled to set. |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Button.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setIcon(Icon value)
public Button.Builder setIcon(Icon value) The icon image. If both icon and text are set, then the icon appears
before the text.
.google.apps.card.v1.Icon icon = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Icon |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setIcon(Icon.Builder builderForValue)
public Button.Builder setIcon(Icon.Builder builderForValue) The icon image. If both icon and text are set, then the icon appears
before the text.
.google.apps.card.v1.Icon icon = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Icon.Builder |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setOnClick(OnClick value)
public Button.Builder setOnClick(OnClick value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
OnClick |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setOnClick(OnClick.Builder builderForValue)
public Button.Builder setOnClick(OnClick.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
OnClick.Builder |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Button.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|
setText(String value)
public Button.Builder setText(String value)The text displayed inside the button.
string text = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe text to set. |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
This builder for chaining. |
setTextBytes(ByteString value)
public Button.Builder setTextBytes(ByteString value)The text displayed inside the button.
string text = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for text to set. |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Button.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Button.Builder |
|