Class: Google::Apps::Card::V1::Button

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/apps/card/v1/card.rb

Overview

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:

Instance Attribute Summary collapse

Instance Attribute Details

#alt_text ⇒ ::String

Returns 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:

  • (::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".



1357
1358
1359
1360
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1357

class Button
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#color ⇒ ::Google::Type::Color

Returns 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:

  • (::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 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
}



1357
1358
1359
1360
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1357

class Button
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#disabled ⇒ ::Boolean

Returns If true, the button is displayed in an inactive state and doesn't respond to user actions.

Returns:

  • (::Boolean) —

    If true, the button is displayed in an inactive state and doesn't respond to user actions.



1357
1358
1359
1360
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1357

class Button
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#icon ⇒ ::Google::Apps::Card::V1::Icon

Returns The icon image. If both icon and text are set, then the icon appears before the text.

Returns:



1357
1358
1359
1360
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1357

class Button
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#on_click ⇒ ::Google::Apps::Card::V1::OnClick

Returns Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.

Returns:



1357
1358
1359
1360
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1357

class Button
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text ⇒ ::String

Returns The text displayed inside the button.

Returns:

  • (::String) —

    The text displayed inside the button.



1357
1358
1359
1360
 
# File 'proto_docs/google/apps/card/v1/card.rb', line 1357

class Button
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end