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

Inherits:

Object

Object
Google::Apps::Card::V1::Button

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:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

#alt_text ⇒ ::String
The alternative text that's used for accessibility.
#color ⇒ ::Google::Type::Color
Optional.
#disabled ⇒ ::Boolean
If true, the button is displayed in an inactive state and doesn't respond to user actions.
#icon ⇒ ::Google::Apps::Card::V1::Icon
An icon displayed inside the button.
#on_click ⇒ ::Google::Apps::Card::V1::OnClick
Required.
#text ⇒ ::String
The text displayed inside the button.
#type ⇒ ::Google::Apps::Card::V1::Button::Type
Optional.

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

# File 'proto_docs/google/apps/card/v1/card.rb', line 1591

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

  # Optional. The
  # [type](https://m3.material.io/components/all-buttons#9134ac95-678e-49ae-a50a-e71948011b05)
  # of a button. If `color` field is set, the `type` is forced to `FILLED`.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Type
    # Don't use. Unspecified.
    TYPE_UNSPECIFIED = 0

    # Outlined buttons are medium-emphasis buttons. They usually contain
    # actions that are important, but aren’t the primary action in a Chat app
    # or an add-on.
    OUTLINED = 1

    # A filled button has a container with a solid color. It has the most
    # visual impact and is recommended for the important and primary action in
    # a Chat app or an add-on.
    FILLED = 2

    # A filled tonal button is an alternative middle ground between filled and
    # outlined buttons. They’re useful in contexts where a lower-priority
    # button requires slightly more emphasis than an outline button would give.
    FILLED_TONAL = 3

    # A button does not have an invisible container in its default state. It is
    # often used for the lowest priority actions, especially when presenting
    # multiple options.
    BORDERLESS = 4
  end
end

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

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

# File 'proto_docs/google/apps/card/v1/card.rb', line 1591

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

  # Optional. The
  # [type](https://m3.material.io/components/all-buttons#9134ac95-678e-49ae-a50a-e71948011b05)
  # of a button. If `color` field is set, the `type` is forced to `FILLED`.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Type
    # Don't use. Unspecified.
    TYPE_UNSPECIFIED = 0

    # Outlined buttons are medium-emphasis buttons. They usually contain
    # actions that are important, but aren’t the primary action in a Chat app
    # or an add-on.
    OUTLINED = 1

    # A filled button has a container with a solid color. It has the most
    # visual impact and is recommended for the important and primary action in
    # a Chat app or an add-on.
    FILLED = 2

    # A filled tonal button is an alternative middle ground between filled and
    # outlined buttons. They’re useful in contexts where a lower-priority
    # button requires slightly more emphasis than an outline button would give.
    FILLED_TONAL = 3

    # A button does not have an invisible container in its default state. It is
    # often used for the lowest priority actions, especially when presenting
    # multiple options.
    BORDERLESS = 4
  end
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.

# File 'proto_docs/google/apps/card/v1/card.rb', line 1591

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

  # Optional. The
  # [type](https://m3.material.io/components/all-buttons#9134ac95-678e-49ae-a50a-e71948011b05)
  # of a button. If `color` field is set, the `type` is forced to `FILLED`.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Type
    # Don't use. Unspecified.
    TYPE_UNSPECIFIED = 0

    # Outlined buttons are medium-emphasis buttons. They usually contain
    # actions that are important, but aren’t the primary action in a Chat app
    # or an add-on.
    OUTLINED = 1

    # A filled button has a container with a solid color. It has the most
    # visual impact and is recommended for the important and primary action in
    # a Chat app or an add-on.
    FILLED = 2

    # A filled tonal button is an alternative middle ground between filled and
    # outlined buttons. They’re useful in contexts where a lower-priority
    # button requires slightly more emphasis than an outline button would give.
    FILLED_TONAL = 3

    # A button does not have an invisible container in its default state. It is
    # often used for the lowest priority actions, especially when presenting
    # multiple options.
    BORDERLESS = 4
  end
end

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

Returns An icon displayed inside the button. If both icon and text are set, then the icon appears before the text.

Returns:

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

# File 'proto_docs/google/apps/card/v1/card.rb', line 1591

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

  # Optional. The
  # [type](https://m3.material.io/components/all-buttons#9134ac95-678e-49ae-a50a-e71948011b05)
  # of a button. If `color` field is set, the `type` is forced to `FILLED`.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Type
    # Don't use. Unspecified.
    TYPE_UNSPECIFIED = 0

    # Outlined buttons are medium-emphasis buttons. They usually contain
    # actions that are important, but aren’t the primary action in a Chat app
    # or an add-on.
    OUTLINED = 1

    # A filled button has a container with a solid color. It has the most
    # visual impact and is recommended for the important and primary action in
    # a Chat app or an add-on.
    FILLED = 2

    # A filled tonal button is an alternative middle ground between filled and
    # outlined buttons. They’re useful in contexts where a lower-priority
    # button requires slightly more emphasis than an outline button would give.
    FILLED_TONAL = 3

    # A button does not have an invisible container in its default state. It is
    # often used for the lowest priority actions, especially when presenting
    # multiple options.
    BORDERLESS = 4
  end
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:

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

# File 'proto_docs/google/apps/card/v1/card.rb', line 1591

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

  # Optional. The
  # [type](https://m3.material.io/components/all-buttons#9134ac95-678e-49ae-a50a-e71948011b05)
  # of a button. If `color` field is set, the `type` is forced to `FILLED`.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Type
    # Don't use. Unspecified.
    TYPE_UNSPECIFIED = 0

    # Outlined buttons are medium-emphasis buttons. They usually contain
    # actions that are important, but aren’t the primary action in a Chat app
    # or an add-on.
    OUTLINED = 1

    # A filled button has a container with a solid color. It has the most
    # visual impact and is recommended for the important and primary action in
    # a Chat app or an add-on.
    FILLED = 2

    # A filled tonal button is an alternative middle ground between filled and
    # outlined buttons. They’re useful in contexts where a lower-priority
    # button requires slightly more emphasis than an outline button would give.
    FILLED_TONAL = 3

    # A button does not have an invisible container in its default state. It is
    # often used for the lowest priority actions, especially when presenting
    # multiple options.
    BORDERLESS = 4
  end
end

#text ⇒ `::String`

Returns The text displayed inside the button.

Returns:

(::String) —
The text displayed inside the button.

# File 'proto_docs/google/apps/card/v1/card.rb', line 1591

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

  # Optional. The
  # [type](https://m3.material.io/components/all-buttons#9134ac95-678e-49ae-a50a-e71948011b05)
  # of a button. If `color` field is set, the `type` is forced to `FILLED`.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Type
    # Don't use. Unspecified.
    TYPE_UNSPECIFIED = 0

    # Outlined buttons are medium-emphasis buttons. They usually contain
    # actions that are important, but aren’t the primary action in a Chat app
    # or an add-on.
    OUTLINED = 1

    # A filled button has a container with a solid color. It has the most
    # visual impact and is recommended for the important and primary action in
    # a Chat app or an add-on.
    FILLED = 2

    # A filled tonal button is an alternative middle ground between filled and
    # outlined buttons. They’re useful in contexts where a lower-priority
    # button requires slightly more emphasis than an outline button would give.
    FILLED_TONAL = 3

    # A button does not have an invisible container in its default state. It is
    # often used for the lowest priority actions, especially when presenting
    # multiple options.
    BORDERLESS = 4
  end
end

#type ⇒ `::Google::Apps::Card::V1::Button::Type`

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

# File 'proto_docs/google/apps/card/v1/card.rb', line 1591

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

  # Optional. The
  # [type](https://m3.material.io/components/all-buttons#9134ac95-678e-49ae-a50a-e71948011b05)
  # of a button. If `color` field is set, the `type` is forced to `FILLED`.
  #
  # [Google Chat apps](https://developers.google.com/workspace/chat):
  module Type
    # Don't use. Unspecified.
    TYPE_UNSPECIFIED = 0

    # Outlined buttons are medium-emphasis buttons. They usually contain
    # actions that are important, but aren’t the primary action in a Chat app
    # or an add-on.
    OUTLINED = 1

    # A filled button has a container with a solid color. It has the most
    # visual impact and is recommended for the important and primary action in
    # a Chat app or an add-on.
    FILLED = 2

    # A filled tonal button is an alternative middle ground between filled and
    # outlined buttons. They’re useful in contexts where a lower-priority
    # button requires slightly more emphasis than an outline button would give.
    FILLED_TONAL = 3

    # A button does not have an invisible container in its default state. It is
    # often used for the lowest priority actions, especially when presenting
    # multiple options.
    BORDERLESS = 4
  end
end

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#alt_text ⇒ ::String

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

#disabled ⇒ ::Boolean

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

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

#text ⇒ ::String

#type ⇒ ::Google::Apps::Card::V1::Button::Type

#alt_text ⇒ `::String`

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

#disabled ⇒ `::Boolean`

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

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

#text ⇒ `::String`

#type ⇒ `::Google::Apps::Card::V1::Button::Type`