Google Chat V1 API - Class Google::Apps::Card::V1::Button (v0.17.0)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Card::V1::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:

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#alt_text

def alt_text() -> ::String
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".

#alt_text=

def alt_text=(value) -> ::String
Parameter
  • value (::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".

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".

#color

def color() -> ::Google::Type::Color
Returns
  • (::Google::Type::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.

#color=

def color=(value) -> ::Google::Type::Color
Parameter
  • value (::Google::Type::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.

Returns
  • (::Google::Type::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.

#disabled

def disabled() -> ::Boolean
Returns
  • (::Boolean) — If true, the button is displayed in an inactive state and doesn't respond to user actions.

#disabled=

def disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

#icon

def icon() -> ::Google::Apps::Card::V1::Icon
Returns

#icon=

def icon=(value) -> ::Google::Apps::Card::V1::Icon
Parameter
  • value (::Google::Apps::Card::V1::Icon) — An icon displayed inside the button. If both icon and text are set, then the icon appears before the text.
Returns

#on_click

def on_click() -> ::Google::Apps::Card::V1::OnClick
Returns

#on_click=

def on_click=(value) -> ::Google::Apps::Card::V1::OnClick
Parameter
  • value (::Google::Apps::Card::V1::OnClick) — Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
Returns

#text

def text() -> ::String
Returns
  • (::String) — The text displayed inside the button.

#text=

def text=(value) -> ::String
Parameter
  • value (::String) — The text displayed inside the button.
Returns
  • (::String) — The text displayed inside the button.

#type

def type() -> ::Google::Apps::Card::V1::Button::Type
Returns
  • (::Google::Apps::Card::V1::Button::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.

#type=

def type=(value) -> ::Google::Apps::Card::V1::Button::Type
Parameter
  • value (::Google::Apps::Card::V1::Button::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.
Returns
  • (::Google::Apps::Card::V1::Button::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.