Interface IconOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Icon, Icon.Builder

public interface IconOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Optional.
    com.google.protobuf.ByteString
    Optional.
     
    Display a custom icon hosted at an HTTPS URL.
    com.google.protobuf.ByteString
    Display a custom icon hosted at an HTTPS URL.
    The crop style applied to the image.
    int
    The crop style applied to the image.
    Display one of the built-in icons provided by Google Workspace.
    com.google.protobuf.ByteString
    Display one of the built-in icons provided by Google Workspace.
    Display one of the [Google Material Icons](https://fonts.google.com/icons).
    Display one of the [Google Material Icons](https://fonts.google.com/icons).
    boolean
    Display a custom icon hosted at an HTTPS URL.
    boolean
    Display one of the built-in icons provided by Google Workspace.
    boolean
    Display one of the [Google Material Icons](https://fonts.google.com/icons).

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasKnownIcon

      boolean hasKnownIcon()
       Display one of the built-in 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 [built-in
       icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
       
      string known_icon = 1;
      Returns:
      Whether the knownIcon field is set.
    • getKnownIcon

      String getKnownIcon()
       Display one of the built-in 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 [built-in
       icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
       
      string known_icon = 1;
      Returns:
      The knownIcon.
    • getKnownIconBytes

      com.google.protobuf.ByteString getKnownIconBytes()
       Display one of the built-in 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 [built-in
       icons](https://developers.google.com/workspace/chat/format-messages#builtinicons).
       
      string known_icon = 1;
      Returns:
      The bytes for knownIcon.
    • hasIconUrl

      boolean hasIconUrl()
       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`.
       
      string icon_url = 2;
      Returns:
      Whether the iconUrl field is set.
    • getIconUrl

      String getIconUrl()
       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`.
       
      string icon_url = 2;
      Returns:
      The iconUrl.
    • getIconUrlBytes

      com.google.protobuf.ByteString getIconUrlBytes()
       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`.
       
      string icon_url = 2;
      Returns:
      The bytes for iconUrl.
    • hasMaterialIcon

      boolean hasMaterialIcon()
       Display one of the [Google Material
       Icons](https://fonts.google.com/icons).
      
       For example, to display a [checkbox
       icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048),
       use
       ```
       "material_icon": {
         "name": "check_box"
       }
       ```
      
       [Google Chat apps](https://developers.google.com/workspace/chat):
       
      .google.apps.card.v1.MaterialIcon material_icon = 5;
      Returns:
      Whether the materialIcon field is set.
    • getMaterialIcon

      MaterialIcon getMaterialIcon()
       Display one of the [Google Material
       Icons](https://fonts.google.com/icons).
      
       For example, to display a [checkbox
       icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048),
       use
       ```
       "material_icon": {
         "name": "check_box"
       }
       ```
      
       [Google Chat apps](https://developers.google.com/workspace/chat):
       
      .google.apps.card.v1.MaterialIcon material_icon = 5;
      Returns:
      The materialIcon.
    • getMaterialIconOrBuilder

      MaterialIconOrBuilder getMaterialIconOrBuilder()
       Display one of the [Google Material
       Icons](https://fonts.google.com/icons).
      
       For example, to display a [checkbox
       icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048),
       use
       ```
       "material_icon": {
         "name": "check_box"
       }
       ```
      
       [Google Chat apps](https://developers.google.com/workspace/chat):
       
      .google.apps.card.v1.MaterialIcon material_icon = 5;
    • getAltText

      String getAltText()
       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/workspace/chat`.
      
       If the icon is set in a [`Button`][google.apps.card.v1.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.
       
      string alt_text = 3;
      Returns:
      The altText.
    • getAltTextBytes

      com.google.protobuf.ByteString getAltTextBytes()
       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/workspace/chat`.
      
       If the icon is set in a [`Button`][google.apps.card.v1.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.
       
      string alt_text = 3;
      Returns:
      The bytes for altText.
    • getImageTypeValue

      int getImageTypeValue()
       The crop style applied to the image. In some cases, applying a
       `CIRCLE` crop causes the image to be drawn larger than a built-in
       icon.
       
      .google.apps.card.v1.Widget.ImageType image_type = 4;
      Returns:
      The enum numeric value on the wire for imageType.
    • getImageType

      Widget.ImageType getImageType()
       The crop style applied to the image. In some cases, applying a
       `CIRCLE` crop causes the image to be drawn larger than a built-in
       icon.
       
      .google.apps.card.v1.Widget.ImageType image_type = 4;
      Returns:
      The imageType.
    • getIconsCase

      Icon.IconsCase getIconsCase()