Interface ButtonOrBuilder (2.63.1)

Version latest

• 2.63.1 (latest)
• 2.62.0
• 2.61.3
• 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 interface ButtonOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAltText()

public abstract 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 abstract 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 abstract 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.

getColorOrBuilder()

public abstract 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

getDisabled()

public abstract 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 abstract 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.

getIconOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract String getText()

The text displayed inside the button.

string text = 1;

Returns
Type	Description
String	The text.

getTextBytes()

public abstract ByteString getTextBytes()

The text displayed inside the button.

string text = 1;

Returns
Type	Description
ByteString	The bytes for text.

getType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.