Class: Google::Apis::ChatV1::GoogleAppsCardV1Icon

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

An icon displayed in a widget on a card. Supports standard and custom icons.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1Icon

Returns a new instance of GoogleAppsCardV1Icon.



1738
1739
1740
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1738

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

Instance Attribute Details

#alt_text ⇒ String

Optional. A description of the icon used for accessibility. If unspecified, the default value "Button" is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, A user's account portrait, or Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers. google.com/chat. If the icon is set in a Button, the altText appears as helper text when the user hovers over the button. However, if the button also sets text, the icon's altText is ignored. Corresponds to the JSON property altText

Returns:

  • (String) 


1715
1716
1717
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1715

def alt_text
  @alt_text
end

#icon_url ⇒ String

Display a custom icon hosted at an HTTPS URL. For example: "iconUrl": " https://developers.google.com/chat/images/quickstart-app-avatar.png" Supported file types include .png and .jpg. Corresponds to the JSON property iconUrl

Returns:

  • (String) 


1722
1723
1724
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1722

def icon_url
  @icon_url
end

#image_type ⇒ String

The crop style applied to the image. In some cases, applying a CIRCLE crop causes the image to be drawn larger than a standard icon. Corresponds to the JSON property imageType

Returns:

  • (String) 


1728
1729
1730
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1728

def image_type
  @image_type
end

#known_icon ⇒ String

Display one of the standard icons provided by Google Workspace. For example, to display an airplane icon, specify AIRPLANE. For a bus, specify BUS. For a full list of supported icons, see standard icons. Corresponds to the JSON property knownIcon

Returns:

  • (String) 


1736
1737
1738
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1736

def known_icon
  @known_icon
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1743
1744
1745
1746
1747
1748
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1743

def update!(**args)
  @alt_text = args[:alt_text] if args.key?(:alt_text)
  @icon_url = args[:icon_url] if args.key?(:icon_url)
  @image_type = args[:image_type] if args.key?(:image_type)
  @known_icon = args[:known_icon] if args.key?(:known_icon)
end