View Source GoogleApi.Chat.V1.Model.GoogleAppsCardV1Icon (google_api_chat v0.36.0)
An icon displayed in a widget on a card. For an example in Google Chat apps, see Add an icon. Supports built-in and custom icons. Google Workspace Add-ons and Chat apps:
Attributes
-
altText
(type:String.t
, default:nil
) - Optional. A description of the icon used for accessibility. If unspecified, the default valueButton
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
, orOpens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat
. If the icon is set in aButton
, thealtText
appears as helper text when the user hovers over the button. However, if the button also setstext
, the icon'saltText
is ignored. -
iconUrl
(type:String.t
, default:nil
) - Display a custom icon hosted at an HTTPS URL. For example:"iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"
Supported file types include.png
and.jpg
. -
imageType
(type:String.t
, default:nil
) - The crop style applied to the image. In some cases, applying aCIRCLE
crop causes the image to be drawn larger than a built-in icon. -
knownIcon
(type:String.t
, default:nil
) - Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specifyAIRPLANE
. For a bus, specifyBUS
. For a full list of supported icons, see built-in icons. -
materialIcon
(type:GoogleApi.Chat.V1.Model.GoogleAppsCardV1MaterialIcon.t
, default:nil
) - Display one of the Google Material Icons. For example, to display a checkbox icon, use"material_icon": { "name": "check_box" }
Google Chat apps:
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Chat.V1.Model.GoogleAppsCardV1Icon{ altText: String.t() | nil, iconUrl: String.t() | nil, imageType: String.t() | nil, knownIcon: String.t() | nil, materialIcon: GoogleApi.Chat.V1.Model.GoogleAppsCardV1MaterialIcon.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.