Class: Google::Apps::Chat::V1::ContextualAddOnMarkup::Card
- Inherits:
-
Object
- Object
- Google::Apps::Chat::V1::ContextualAddOnMarkup::Card
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/chat/v1/contextual_addon.rb
Overview
A card is a UI element that can contain UI widgets such as text and images.
Defined Under Namespace
Classes: CardAction, CardHeader, Section
Instance Attribute Summary collapse
-
#card_actions ⇒ ::Array<::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardAction>
The actions of this card.
-
#header ⇒ ::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardHeader
The header of the card.
-
#name ⇒ ::String
Name of the card.
-
#sections ⇒ ::Array<::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::Section>
Sections are separated by a line divider.
Instance Attribute Details
permalink #card_actions ⇒ ::Array<::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardAction>
Returns The actions of this card.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'proto_docs/google/chat/v1/contextual_addon.rb', line 43 class Card include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] title # @return [::String] # The title must be specified. The header has a fixed height: if both a # title and subtitle is specified, each takes up one line. If only the # title is specified, it takes up both lines. # @!attribute [rw] subtitle # @return [::String] # The subtitle of the card header. # @!attribute [rw] image_style # @return [::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardHeader::ImageStyle] # The image's type (for example, square border or circular border). # @!attribute [rw] image_url # @return [::String] # The URL of the image in the card header. class CardHeader include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module ImageStyle IMAGE_STYLE_UNSPECIFIED = 0 # Square border. IMAGE = 1 # Circular border. AVATAR = 2 end end # A section contains a collection of widgets that are rendered # (vertically) in the order that they are specified. Across all platforms, # cards have a narrow fixed width, so # there's currently no need for layout properties (for example, float). # @!attribute [rw] header # @return [::String] # The header of the section. Formatted text is # supported. For more information # about formatting text, see # [Formatting text in Google Chat # apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) # and # [Formatting # text in Google Workspace # Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). # @!attribute [rw] widgets # @return [::Array<::Google::Apps::Chat::V1::WidgetMarkup>] # A section must contain at least one widget. class Section include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A card action is # the action associated with the card. For an invoice card, a # typical action would be: delete invoice, email invoice or open the # invoice in browser. # # Not supported by Google Chat apps. # @!attribute [rw] action_label # @return [::String] # The label used to be displayed in the action menu item. # @!attribute [rw] on_click # @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick] # The onclick action for this action item. class CardAction include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
permalink #header ⇒ ::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardHeader
Returns The header of the card. A header usually contains a title and an image.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'proto_docs/google/chat/v1/contextual_addon.rb', line 43 class Card include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] title # @return [::String] # The title must be specified. The header has a fixed height: if both a # title and subtitle is specified, each takes up one line. If only the # title is specified, it takes up both lines. # @!attribute [rw] subtitle # @return [::String] # The subtitle of the card header. # @!attribute [rw] image_style # @return [::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardHeader::ImageStyle] # The image's type (for example, square border or circular border). # @!attribute [rw] image_url # @return [::String] # The URL of the image in the card header. class CardHeader include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module ImageStyle IMAGE_STYLE_UNSPECIFIED = 0 # Square border. IMAGE = 1 # Circular border. AVATAR = 2 end end # A section contains a collection of widgets that are rendered # (vertically) in the order that they are specified. Across all platforms, # cards have a narrow fixed width, so # there's currently no need for layout properties (for example, float). # @!attribute [rw] header # @return [::String] # The header of the section. Formatted text is # supported. For more information # about formatting text, see # [Formatting text in Google Chat # apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) # and # [Formatting # text in Google Workspace # Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). # @!attribute [rw] widgets # @return [::Array<::Google::Apps::Chat::V1::WidgetMarkup>] # A section must contain at least one widget. class Section include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A card action is # the action associated with the card. For an invoice card, a # typical action would be: delete invoice, email invoice or open the # invoice in browser. # # Not supported by Google Chat apps. # @!attribute [rw] action_label # @return [::String] # The label used to be displayed in the action menu item. # @!attribute [rw] on_click # @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick] # The onclick action for this action item. class CardAction include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
permalink #name ⇒ ::String
Returns Name of the card.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'proto_docs/google/chat/v1/contextual_addon.rb', line 43 class Card include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] title # @return [::String] # The title must be specified. The header has a fixed height: if both a # title and subtitle is specified, each takes up one line. If only the # title is specified, it takes up both lines. # @!attribute [rw] subtitle # @return [::String] # The subtitle of the card header. # @!attribute [rw] image_style # @return [::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardHeader::ImageStyle] # The image's type (for example, square border or circular border). # @!attribute [rw] image_url # @return [::String] # The URL of the image in the card header. class CardHeader include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module ImageStyle IMAGE_STYLE_UNSPECIFIED = 0 # Square border. IMAGE = 1 # Circular border. AVATAR = 2 end end # A section contains a collection of widgets that are rendered # (vertically) in the order that they are specified. Across all platforms, # cards have a narrow fixed width, so # there's currently no need for layout properties (for example, float). # @!attribute [rw] header # @return [::String] # The header of the section. Formatted text is # supported. For more information # about formatting text, see # [Formatting text in Google Chat # apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) # and # [Formatting # text in Google Workspace # Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). # @!attribute [rw] widgets # @return [::Array<::Google::Apps::Chat::V1::WidgetMarkup>] # A section must contain at least one widget. class Section include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A card action is # the action associated with the card. For an invoice card, a # typical action would be: delete invoice, email invoice or open the # invoice in browser. # # Not supported by Google Chat apps. # @!attribute [rw] action_label # @return [::String] # The label used to be displayed in the action menu item. # @!attribute [rw] on_click # @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick] # The onclick action for this action item. class CardAction include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
permalink #sections ⇒ ::Array<::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::Section>
Returns Sections are separated by a line divider.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'proto_docs/google/chat/v1/contextual_addon.rb', line 43 class Card include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] title # @return [::String] # The title must be specified. The header has a fixed height: if both a # title and subtitle is specified, each takes up one line. If only the # title is specified, it takes up both lines. # @!attribute [rw] subtitle # @return [::String] # The subtitle of the card header. # @!attribute [rw] image_style # @return [::Google::Apps::Chat::V1::ContextualAddOnMarkup::Card::CardHeader::ImageStyle] # The image's type (for example, square border or circular border). # @!attribute [rw] image_url # @return [::String] # The URL of the image in the card header. class CardHeader include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module ImageStyle IMAGE_STYLE_UNSPECIFIED = 0 # Square border. IMAGE = 1 # Circular border. AVATAR = 2 end end # A section contains a collection of widgets that are rendered # (vertically) in the order that they are specified. Across all platforms, # cards have a narrow fixed width, so # there's currently no need for layout properties (for example, float). # @!attribute [rw] header # @return [::String] # The header of the section. Formatted text is # supported. For more information # about formatting text, see # [Formatting text in Google Chat # apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) # and # [Formatting # text in Google Workspace # Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). # @!attribute [rw] widgets # @return [::Array<::Google::Apps::Chat::V1::WidgetMarkup>] # A section must contain at least one widget. class Section include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A card action is # the action associated with the card. For an invoice card, a # typical action would be: delete invoice, email invoice or open the # invoice in browser. # # Not supported by Google Chat apps. # @!attribute [rw] action_label # @return [::String] # The label used to be displayed in the action menu item. # @!attribute [rw] on_click # @return [::Google::Apps::Chat::V1::WidgetMarkup::OnClick] # The onclick action for this action item. class CardAction include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |