Packages

final case class Icon(icons: Icons = com.google.apps.card.v1.card.Icon.Icons.Empty, altText: String = "", imageType: ImageType = com.google.apps.card.v1.card.Widget.ImageType.SQUARE, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Icon] with Product with Serializable

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

altText

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.

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.

Annotations
@SerialVersionUID()
Source
Icon.scala
Linear Supertypes
Updatable[Icon], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Icon
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Icon(icons: Icons = com.google.apps.card.v1.card.Icon.Icons.Empty, altText: String = "", imageType: ImageType = com.google.apps.card.v1.card.Widget.ImageType.SQUARE, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    altText

    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.

    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.

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. val altText: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clearIcons: Icon
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def companion: Icon.type
    Definition Classes
    Icon → GeneratedMessage
  9. def discardUnknownFields: Icon
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Icon → GeneratedMessage
  14. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Icon → GeneratedMessage
  15. def getIconUrl: String
  16. def getKnownIcon: String
  17. def getMaterialIcon: MaterialIcon
  18. val icons: Icons
  19. val imageType: ImageType
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def serializedSize: Int
    Definition Classes
    Icon → GeneratedMessage
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  28. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  29. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  30. def toProtoString: String
    Definition Classes
    Icon → GeneratedMessage
  31. val unknownFields: UnknownFieldSet
  32. def update(ms: (Lens[Icon, Icon]) => Mutation[Icon]*): Icon
    Definition Classes
    Updatable
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. def withAltText(__v: String): Icon
  37. def withIconUrl(__v: String): Icon
  38. def withIcons(__v: Icons): Icon
  39. def withImageType(__v: ImageType): Icon
  40. def withKnownIcon(__v: String): Icon
  41. def withMaterialIcon(__v: MaterialIcon): Icon
  42. def withUnknownFields(__v: UnknownFieldSet): Icon
  43. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  44. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Icon → GeneratedMessage
  45. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[Icon]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped