Class: Google::Apps::Card::V1::Chip

Inherits:

Object

• Object
• Google::Apps::Card::V1::Chip

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 chip that users can click.

Google Workspace add-ons and Chat apps:

Instance Attribute Summary

• #alt_text ⇒ ::String

  The alternative text that's used for accessibility.

• #disabled ⇒ ::Boolean

  Whether the chip is in an inactive state and ignores user actions.

• #enabled ⇒ ::Boolean deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

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

  The icon image.

• #label ⇒ ::String

  The text displayed inside the chip.

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

  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 chip does. For example, if a chip opens a hyperlink, 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 chip does. For example, if a chip opens a hyperlink, 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 2600

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

#disabled ⇒ ::Boolean

Returns Whether the chip is in an inactive state and ignores user actions. Defaults to false.

Returns:

• (::Boolean) —

  Whether the chip is in an inactive state and ignores user actions. Defaults to false.

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

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

#enabled ⇒ ::Boolean

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Whether the chip is in an active state and responds to user actions. Defaults to true. Deprecated. Use disabled instead.

Returns:

• (::Boolean) —

  Whether the chip is in an active state and responds to user actions. Defaults to true. Deprecated. Use disabled instead.

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

class Chip
  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:

• (::Google::Apps::Card::V1::Icon) —

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

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

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

#label ⇒ ::String

Returns The text displayed inside the chip.

Returns:

• (::String) —

  The text displayed inside the chip.

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

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

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

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

Returns:

• (::Google::Apps::Card::V1::OnClick) —

  Optional. The action to perform when a user clicks the chip, such as opening a hyperlink or running a custom function.

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

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