Class Button.Builder (2.63.1) 

public static final class Button.Builder extends GeneratedMessageV3.Builder<Button.Builder> implements ButtonOrBuilder

A 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.Builder

Implements

ButtonOrBuilder

Static 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
Overrides

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
Overrides

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()

Optional. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

` "color": { "red": 1, "green": 0, "blue": 0, }

The alpha` field is unavailable for button color. If specified, this field is ignored.

.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
Overrides

clearIcon()

public Button.Builder clearIcon()

An icon displayed inside the button. 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
Overrides

clearText()

public Button.Builder clearText()

The text displayed inside the button.

string text = 1;

Returns
Type Description
Button.Builder

This builder for chaining.

clearType()

public Button.Builder clearType()

Optional. The type of a button. If unset, button type defaults to OUTLINED. If the color field is set, the button type is forced to FILLED and any value set for this field is ignored.

.google.apps.card.v1.Button.Type type = 7;

Returns
Type Description
Button.Builder

This builder for chaining.

clone()

public Button.Builder clone()
Returns
Type Description
Button.Builder
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/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()

Optional. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

` "color": { "red": 1, "green": 0, "blue": 0, }

The alpha` field is unavailable for button color. If specified, this field is ignored.

.google.type.Color color = 3;

Returns
Type Description
Color

The color.

getColorBuilder()

public Color.Builder getColorBuilder()

Optional. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

` "color": { "red": 1, "green": 0, "blue": 0, }

The alpha` field is unavailable for button color. If specified, this field is ignored.

.google.type.Color color = 3;

Returns
Type Description
Color.Builder

getColorOrBuilder()

public ColorOrBuilder getColorOrBuilder()

Optional. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

` "color": { "red": 1, "green": 0, "blue": 0, }

The alpha` field is unavailable for button color. If specified, this field is ignored.

.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
Overrides

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()

An icon displayed inside the button. 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()

An icon displayed inside the button. 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()

An icon displayed inside the button. 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.

getType()

public Button.Type getType()

Optional. The type of a button. If unset, button type defaults to OUTLINED. If the color field is set, the button type is forced to FILLED and any value set for this field is ignored.

.google.apps.card.v1.Button.Type type = 7;

Returns
Type Description
Button.Type

The type.

getTypeValue()

public int getTypeValue()

Optional. The type of a button. If unset, button type defaults to OUTLINED. If the color field is set, the button type is forced to FILLED and any value set for this field is ignored.

.google.apps.card.v1.Button.Type type = 7;

Returns
Type Description
int

The enum numeric value on the wire for type.

hasColor()

public boolean hasColor()

Optional. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

` "color": { "red": 1, "green": 0, "blue": 0, }

The alpha` field is unavailable for button color. If specified, this field is ignored.

.google.type.Color color = 3;

Returns
Type Description
boolean

Whether the color field is set.

hasIcon()

public boolean hasIcon()

An icon displayed inside the button. 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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeColor(Color value)

public Button.Builder mergeColor(Color value)

Optional. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

` "color": { "red": 1, "green": 0, "blue": 0, }

The alpha` field is unavailable for button color. If specified, this field is ignored.

.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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Button.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Button.Builder
Overrides

mergeIcon(Icon value)

public Button.Builder mergeIcon(Icon value)

An icon displayed inside the button. 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
Overrides

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 String

The 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 ByteString

The bytes for altText to set.
Returns
Type Description
Button.Builder

This builder for chaining.

setColor(Color value)

public Button.Builder setColor(Color value)

Optional. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

` "color": { "red": 1, "green": 0, "blue": 0, }

The alpha` field is unavailable for button color. If specified, this field is ignored.

.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)

Optional. The color of the button. If set, the button type is set to FILLED and the color of text and icon fields are set to a contrasting color for readability. For example, if the button color is set to blue, any text or icons in the button are set to white.

To set the button color, specify a value for the red, green, and blue fields. The value must be a float number between 0 and 1 based on the RGB color value, where 0 (0/255) represents the absence of color and 1 (255/255) represents the maximum intensity of the color.

For example, the following sets the color to red at its maximum intensity:

` "color": { "red": 1, "green": 0, "blue": 0, }

The alpha` field is unavailable for button color. If specified, this field is ignored.

.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 boolean

The 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
Overrides

setIcon(Icon value)

public Button.Builder setIcon(Icon value)

An icon displayed inside the button. 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)

An icon displayed inside the button. 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
Overrides

setText(String value)

public Button.Builder setText(String value)

The text displayed inside the button.

string text = 1;

Parameter
Name Description
value String

The 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 ByteString

The bytes for text to set.
Returns
Type Description
Button.Builder

This builder for chaining.

setType(Button.Type value)

public Button.Builder setType(Button.Type value)

Optional. The type of a button. If unset, button type defaults to OUTLINED. If the color field is set, the button type is forced to FILLED and any value set for this field is ignored.

.google.apps.card.v1.Button.Type type = 7;

Parameter
Name Description
value Button.Type

The type to set.
Returns
Type Description
Button.Builder

This builder for chaining.

setTypeValue(int value)

public Button.Builder setTypeValue(int value)

Optional. The type of a button. If unset, button type defaults to OUTLINED. If the color field is set, the button type is forced to FILLED and any value set for this field is ignored.

.google.apps.card.v1.Button.Type type = 7;

Parameter
Name Description
value int

The enum numeric value on the wire for type 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
Overrides