Class: Google::Apis::ChatV1::GoogleAppsCardV1OnClick

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

Represents how to respond when users click an interactive element on a card, such as a button.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1OnClick

Returns a new instance of GoogleAppsCardV1OnClick.



1899
1900
1901
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1899

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

Instance Attribute Details

#action ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Action

An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. If the action is triggered, the form values are sent to the server. Corresponds to the JSON property action

Returns:



1858
1859
1860
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1858

def action
  @action
end

#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, 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 info. Example contact card ` "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:



1885
1886
1887
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1885

def card
  @card
end

#open_dynamic_link_action ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Action

An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. If the action is triggered, the form values are sent to the server. Corresponds to the JSON property openDynamicLinkAction

Returns:



1892
1893
1894
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1892

def open_dynamic_link_action
  @open_dynamic_link_action
end

#open_link ⇒ Google::Apis::ChatV1::GoogleAppsCardV1OpenLink

Represents an onClick event that opens a hyperlink. Corresponds to the JSON property openLink

Returns:



1897
1898
1899
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1897

def open_link
  @open_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1904
1905
1906
1907
1908
1909
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1904

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