Class GoogleAppsCardV1Button
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:
Implements
Inherited Members
Namespace: Google.Apis.HangoutsChat.v1.Data
Assembly: Google.Apis.HangoutsChat.v1.dll
Syntax
public class GoogleAppsCardV1Button : IDirectResponseSchema
Properties
AltText
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".
Declaration
[JsonProperty("altText")]
public virtual string AltText { get; set; }
Property Value
Type | Description |
---|---|
string |
Color
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.
Declaration
[JsonProperty("color")]
public virtual Color Color { get; set; }
Property Value
Type | Description |
---|---|
Color |
Disabled
If true
, the button is displayed in an inactive state and doesn't respond to user actions.
Declaration
[JsonProperty("disabled")]
public virtual bool? Disabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Icon
An icon displayed inside the button. If both icon
and text
are set, then the icon appears before the
text.
Declaration
[JsonProperty("icon")]
public virtual GoogleAppsCardV1Icon Icon { get; set; }
Property Value
Type | Description |
---|---|
GoogleAppsCardV1Icon |
OnClick
Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
Declaration
[JsonProperty("onClick")]
public virtual GoogleAppsCardV1OnClick OnClick { get; set; }
Property Value
Type | Description |
---|---|
GoogleAppsCardV1OnClick |
Text
The text displayed inside the button.
Declaration
[JsonProperty("text")]
public virtual string Text { get; set; }
Property Value
Type | Description |
---|---|
string |
Type
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 Chat
apps:
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type | Description |
---|---|
string |