Reference documentation and code samples for the Google Apps Chat V1 Client class Button.
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:
Generated from protobuf message google.apps.card.v1.Button
Namespace
Google \ Apps \ Card \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text |
string
The text displayed inside the button. |
↳ icon |
Icon
The icon image. If both |
↳ color |
Google\Type\Color
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 |
↳ on_click |
OnClick
Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function. |
↳ disabled |
bool
If |
↳ alt_text |
string
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". |
getText
The text displayed inside the button.
| Returns | |
|---|---|
| Type | Description |
string |
|
setText
The text displayed inside the button.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIcon
The icon image. If both icon and text are set, then the icon appears
before the text.
| Returns | |
|---|---|
| Type | Description |
Icon|null |
|
hasIcon
clearIcon
setIcon
The icon image. If both icon and text are set, then the icon appears
before the text.
| Parameter | |
|---|---|
| Name | Description |
var |
Icon
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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
}
| Returns | |
|---|---|
| Type | Description |
Google\Type\Color|null |
|
hasColor
clearColor
setColor
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
}
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Color
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOnClick
Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
| Returns | |
|---|---|
| Type | Description |
OnClick|null |
|
hasOnClick
clearOnClick
setOnClick
Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
| Parameter | |
|---|---|
| Name | Description |
var |
OnClick
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisabled
If true, the button is displayed in an inactive state and doesn't respond
to user actions.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisabled
If true, the button is displayed in an inactive state and doesn't respond
to user actions.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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".
| Returns | |
|---|---|
| Type | Description |
string |
|
setAltText
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".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|