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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ButtonImplements
ButtonOrBuilderStatic Fields
ALT_TEXT_FIELD_NUMBER
public
static
final
int
ALT_TEXT_FIELD_NUMBER
COLOR_FIELD_NUMBER
public
static
final
int
COLOR_FIELD_NUMBER
DISABLED_FIELD_NUMBER
public
static
final
int
DISABLED_FIELD_NUMBER
ICON_FIELD_NUMBER
public
static
final
int
ICON_FIELD_NUMBER
ON_CLICK_FIELD_NUMBER
public
static
final
int
ON_CLICK_FIELD_NUMBER
TEXT_FIELD_NUMBER
public
static
final
int
TEXT_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Button
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Button
.
Builder
newBuilder
()
newBuilder(Button prototype)
public
static
Button
.
Builder
newBuilder
(
Button
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Button
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Button
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Button
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Button
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Button
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Button
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Button
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Button
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Button
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Button
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Button
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Button
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Button>
parser
()
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
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;
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;
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;
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;
com.google.type.ColorOrBuilder
getDefaultInstanceForType()
public
Button
getDefaultInstanceForType
()
getDisabled()
public
boolean
getDisabled
()
If true
, the button is displayed in an inactive state and doesn't respond
to user actions.
bool disabled = 5;
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;
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;
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;
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;
getParserForType()
public
Parser<Button>
getParserForType
()
getSerializedSize()
public
int
getSerializedSize
()
getText()
public
String
getText
()
The text displayed inside the button.
string text = 1;
getTextBytes()
public
ByteString
getTextBytes
()
The text displayed inside the button.
string text = 1;
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;
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;
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;
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Button
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Button
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
Button
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
