Interface ButtonOrBuilder (2.37.1)

Version latest

• 2.37.1 (latest)
• 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/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/chat".

string alt_text = 6;

Returns
Type	Description
ByteString	The bytes for altText.

getColor()

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

getColorOrBuilder()

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

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

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.

getIconOrBuilder()

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

hasColor()

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