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
An icon displayed inside the button. If both |
↳ color |
Google\Type\Color
Optional. The color of the button. If set, the button |
↳ 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". |
↳ type |
int
Optional. The type of a button. If unset, button type defaults to |
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
An icon displayed inside the button. If both icon and text are set,
then the icon appears before the text.
| Returns | |
|---|---|
| Type | Description |
Icon|null |
|
hasIcon
clearIcon
setIcon
An icon displayed inside the button. If both icon and text are set,
then the icon appears before the text.
| Parameter | |
|---|---|
| Name | Description |
var |
Icon
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
Google\Type\Color|null |
|
hasColor
clearColor
setColor
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.
| 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 |
|
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.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Type. |
setType
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Type. |
| Returns | |
|---|---|
| Type | Description |
$this |
|