t

com.google.apps.card.v1

IconOrBuilder

trait IconOrBuilder extends MessageOrBuilder

Source
IconOrBuilder.java
Linear Supertypes
MessageOrBuilder, MessageLiteOrBuilder, AnyRef, Any
Known Subclasses
Icon
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IconOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  2. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  3. abstract 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.

  4. abstract 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.

  5. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  6. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  7. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  8. abstract 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.

  9. abstract 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.

  10. abstract def getIconsCase(): IconsCase
  11. abstract 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.

  12. abstract 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.

  13. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  14. abstract 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.

  15. abstract 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.

  16. abstract 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.

  17. abstract 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;

  18. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  19. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  20. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  21. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  22. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  23. abstract 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.

  24. abstract 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.

  25. abstract 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.

  26. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  27. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder

Concrete 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]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped