final class Icon extends GeneratedMessageV3 with IconOrBuilder

An icon displayed in a widget on a card. For an example in Google Chat apps,
see [Add an
icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon).

Supports
[built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons)
and
[custom](https://developers.google.com/workspace/chat/format-messages#customicons)
icons.

[Google Workspace Add-ons and Chat
apps](https://developers.google.com/workspace/extend):

Protobuf type google.apps.card.v1.Icon

Source
Icon.java
Linear Supertypes
IconOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Icon
  2. IconOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    Icon → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  9. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  10. def getAltText(): 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/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.


    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.

    Definition Classes
    Icon → IconOrBuilder
    Annotations
    @Override()
  11. def getAltTextBytes(): ByteString

    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.


    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.

    Definition Classes
    Icon → IconOrBuilder
    Annotations
    @Override()
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. def getDefaultInstanceForType(): Icon
    Definition Classes
    Icon → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  14. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getIconUrl(): String

    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`.


    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.

    Definition Classes
    Icon → IconOrBuilder
  17. def getIconUrlBytes(): ByteString

    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`.


    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.

    Definition Classes
    Icon → IconOrBuilder
  18. def getIconsCase(): IconsCase
    Definition Classes
    Icon → IconOrBuilder
  19. def getImageType(): ImageType

    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.


    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.

    Definition Classes
    Icon → IconOrBuilder
    Annotations
    @Override()
  20. def getImageTypeValue(): Int

    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.


    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.

    Definition Classes
    Icon → IconOrBuilder
    Annotations
    @Override()
  21. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  22. def getKnownIcon(): String

    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).


    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.

    Definition Classes
    Icon → IconOrBuilder
  23. def getKnownIconBytes(): ByteString

    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).


    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.

    Definition Classes
    Icon → IconOrBuilder
  24. def getMaterialIcon(): MaterialIcon

    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):


    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.

    Definition Classes
    Icon → IconOrBuilder
    Annotations
    @Override()
  25. def getMaterialIconOrBuilder(): MaterialIconOrBuilder

    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):


    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;

    Definition Classes
    Icon → IconOrBuilder
    Annotations
    @Override()
  26. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  27. def getParserForType(): Parser[Icon]
    Definition Classes
    Icon → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  28. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  29. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  30. def getSerializedSize(): Int
    Definition Classes
    Icon → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  31. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  32. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  33. def hasIconUrl(): Boolean

    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`.


    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.

    Definition Classes
    Icon → IconOrBuilder
  34. def hasKnownIcon(): Boolean

    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).


    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.

    Definition Classes
    Icon → IconOrBuilder
  35. def hasMaterialIcon(): Boolean

    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):


    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.

    Definition Classes
    Icon → IconOrBuilder
    Annotations
    @Override()
  36. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  37. def hashCode(): Int
    Definition Classes
    Icon → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  38. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    Icon → GeneratedMessageV3
    Annotations
    @Override()
  39. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  40. final def isInitialized(): Boolean
    Definition Classes
    Icon → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    Icon → GeneratedMessageV3
    Annotations
    @Override()
  45. def newBuilderForType(): Builder
    Definition Classes
    Icon → Message → MessageLite
    Annotations
    @Override()
  46. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  47. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    Icon → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  50. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  51. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. def toBuilder(): Builder
    Definition Classes
    Icon → Message → MessageLite
    Annotations
    @Override()
  54. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  55. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  56. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  61. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  62. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    Icon → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  63. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from IconOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped