Class: Google::Apis::ChatV1::CardWithId

Inherits:

Object

• Object
• Google::Apis::ChatV1::CardWithId

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

Widgets for Chat apps to specify.

Instance Attribute Summary

• #card ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Card

  Cards support a defined layout, interactive UI elements like buttons, and rich media like images.

• #card_id ⇒ String

  Required for cardsV2 messages.

Instance Method Summary

• #initialize(**args) ⇒ CardWithId constructor

  A new instance of CardWithId.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ CardWithId

Returns a new instance of CardWithId.

# File 'lib/google/apis/chat_v1/classes.rb', line 444

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

Instance Attribute Details

#card ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Card

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. In Google Chat, cards appear in several places: - As stand-alone messages. - Accompanying a text message, just beneath the text message. - As a dialog. The following example JSON creates a "contact card" that features: - A header with the contact's name, job title, and avatar picture. - A section with the contact information, including formatted text. - Buttons that users can click to share the contact, or see more or less information. For more examples, see Design dynamic, interactive, and consistent UIs with cards. ` "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", ` ], ` ` `, ], ` `, ], `, ], `, ` ], ` Corresponds to the JSON property card

Returns:

• (Google::Apis::ChatV1::GoogleAppsCardV1Card)

# File 'lib/google/apis/chat_v1/classes.rb', line 436

def card
  @card
end

#card_id ⇒ String

Required for cardsV2 messages. Chat app-specified identifier for this widget. Scoped within a message. Corresponds to the JSON property cardId

Returns:

• (String)

# File 'lib/google/apis/chat_v1/classes.rb', line 442

def card_id
  @card_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/chat_v1/classes.rb', line 449

def update!(**args)
  @card = args[:card] if args.key?(:card)
  @card_id = args[:card_id] if args.key?(:card_id)
end