Class: Google::Apis::ChatV1::GoogleAppsCardV1Card

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb

Overview

A card interface displayed in a Google Chat message or Google Workspace Add-on. Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step. Card builder To learn how to build cards, see the following documentation: * For Google Chat apps, see Design dynamic, interactive, and consistent UIs with cards. * For Google Workspace Add-ons, see Card-based interfaces. Example: Card message for a Google Chat app Example contact card To create the sample card message in Google Chat, use the following JSON: ` "cardsV2": [ ` "cardId": "unique-card-id", "card": ` "header": ` "title": "Sasha", "subtitle": " Software Engineer", "imageUrl": "https://developers.google.com/chat/images/ quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha", `, "sections": [ ` "header": "Contact Info", "collapsible": true, " uncollapsibleWidgetsCount": 1, "widgets": [ ` "decoratedText": ` "startIcon": ` "knownIcon": "EMAIL", `, "text": "sasha@example.com", ` `, ` "decoratedText": ` "startIcon": ` "knownIcon": "PERSON", `, "text": "Online", `, `, ` " decoratedText": ` "startIcon": ` "knownIcon": "PHONE", `, "text": "+1 (555) 555-1234", ` `, ` "buttonList": ` "buttons": [ ` "text": "Share", "onClick": ` "openLink": ` "url": "https://example.com/share", ` ` `, ` "text": "Edit", " onClick": ` "action": ` "function": "goToView", "parameters": [ ` "key": " viewType", "value": "EDIT", ` ], ` ` `, ], ` `, ], `, ], `, ` ], `

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1Card

Returns a new instance of GoogleAppsCardV1Card.



1515
1516
1517
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1515

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#card_actions ⇒ Array<Google::Apis::ChatV1::GoogleAppsCardV1CardAction>

The card's actions. Actions are added to the card's toolbar menu. Google Workspace Add-ons: For example, the following JSON constructs a card action menu with Settings and Send Feedback options: "card_actions": [ ` "actionLabel": "Settings", " onClick": ` "action": ` "functionName": "goToView", "parameters": [ ` "key": " viewType", "value": "SETTING" ` ], "loadIndicator": "LoadIndicator.SPINNER" ` ` `, ` "actionLabel": "Send Feedback", "onClick": ` "openLink": ` "url": "https: //example.com/feedback" ` ` ` ] Corresponds to the JSON property cardActions

Returns:



1461
1462
1463
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1461

def card_actions
  @card_actions
end

#display_style ⇒ String

In Google Workspace Add-ons, sets the display properties of the peekCardHeader. Google Workspace Add-ons: Corresponds to the JSON property displayStyle

Returns:

  • (String) 


1468
1469
1470
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1468

def display_style
  @display_style
end

#fixed_footer ⇒ Google::Apis::ChatV1::GoogleAppsCardV1CardFixedFooter

A persistent (sticky) footer that that appears at the bottom of the card. Setting fixedFooter without specifying a primaryButton or a secondaryButton causes an error. For Chat apps, you can use fixed footers in dialogs, but not card messages. For an example in Google Chat apps, see Card footer. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property fixedFooter

Returns:



1480
1481
1482
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1480

def fixed_footer
  @fixed_footer
end

#header ⇒ Google::Apis::ChatV1::GoogleAppsCardV1CardHeader

Represents a card header. For an example in Google Chat apps, see Card header. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property header

Returns:



1487
1488
1489
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1487

def header
  @header
end

#name ⇒ String

Name of the card. Used as a card identifier in card navigation. Google Workspace Add-ons: Corresponds to the JSON property name

Returns:

  • (String) 


1493
1494
1495
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1493

def name
  @name
end

#peek_card_header ⇒ Google::Apis::ChatV1::GoogleAppsCardV1CardHeader

Represents a card header. For an example in Google Chat apps, see Card header. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property peekCardHeader

Returns:



1500
1501
1502
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1500

def peek_card_header
  @peek_card_header
end

#section_divider_style ⇒ String

The divider style between sections. Corresponds to the JSON property sectionDividerStyle

Returns:

  • (String) 


1505
1506
1507
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1505

def section_divider_style
  @section_divider_style
end

#sections ⇒ Array<Google::Apis::ChatV1::GoogleAppsCardV1Section>

Contains a collection of widgets. Each section has its own, optional header. Sections are visually separated by a line divider. For an example in Google Chat apps, see Card section. Corresponds to the JSON property sections

Returns:



1513
1514
1515
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1513

def sections
  @sections
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1520

def update!(**args)
  @card_actions = args[:card_actions] if args.key?(:card_actions)
  @display_style = args[:display_style] if args.key?(:display_style)
  @fixed_footer = args[:fixed_footer] if args.key?(:fixed_footer)
  @header = args[:header] if args.key?(:header)
  @name = args[:name] if args.key?(:name)
  @peek_card_header = args[:peek_card_header] if args.key?(:peek_card_header)
  @section_divider_style = args[:section_divider_style] if args.key?(:section_divider_style)
  @sections = args[:sections] if args.key?(:sections)
end