Class Icon (2.43.0) 

public final class Icon extends GeneratedMessageV3 implements IconOrBuilder

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:

Protobuf type google.apps.card.v1.Icon

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Icon

Implements

IconOrBuilder

Static Fields

ALT_TEXT_FIELD_NUMBER

public static final int ALT_TEXT_FIELD_NUMBER
Field Value
Type Description
int

ICON_URL_FIELD_NUMBER

public static final int ICON_URL_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_TYPE_FIELD_NUMBER

public static final int IMAGE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

KNOWN_ICON_FIELD_NUMBER

public static final int KNOWN_ICON_FIELD_NUMBER
Field Value
Type Description
int

MATERIAL_ICON_FIELD_NUMBER

public static final int MATERIAL_ICON_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Icon getDefaultInstance()
Returns
Type Description
Icon

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Icon.Builder newBuilder()
Returns
Type Description
Icon.Builder

newBuilder(Icon prototype)

public static Icon.Builder newBuilder(Icon prototype)
Parameter
Name Description
prototype Icon
Returns
Type Description
Icon.Builder

parseDelimitedFrom(InputStream input)

public static Icon parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Icon
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Icon parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Icon
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Icon parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Icon
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Icon
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Icon parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Icon
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Icon
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Icon parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Icon
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Icon
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Icon parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Icon
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Icon
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Icon parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Icon
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Icon
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Icon> parser()
Returns
Type Description
Parser<Icon>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAltText()

public 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, 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
Type Description
String

The altText.

getAltTextBytes()

public 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, 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
Type Description
ByteString

The bytes for altText.

getDefaultInstanceForType()

public Icon getDefaultInstanceForType()
Returns
Type Description
Icon

getIconUrl()

public 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
Type Description
String

The iconUrl.

getIconUrlBytes()

public 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
Type Description
ByteString

The bytes for iconUrl.

getIconsCase()

public Icon.IconsCase getIconsCase()
Returns
Type Description
Icon.IconsCase

getImageType()

public 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
Type Description
Widget.ImageType

The imageType.

getImageTypeValue()

public 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
Type Description
int

The enum numeric value on the wire for imageType.

getKnownIcon()

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

string known_icon = 1;

Returns
Type Description
String

The knownIcon.

getKnownIconBytes()

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

string known_icon = 1;

Returns
Type Description
ByteString

The bytes for knownIcon.

getMaterialIcon()

public MaterialIcon getMaterialIcon()

Display one of the Google Material Icons.

For example, to display a checkbox icon, use <code><code> "material_icon": { "name": "check_box" } </code></code>

Google Chat apps:

.google.apps.card.v1.MaterialIcon material_icon = 5;

Returns
Type Description
MaterialIcon

The materialIcon.

getMaterialIconOrBuilder()

public MaterialIconOrBuilder getMaterialIconOrBuilder()

Display one of the Google Material Icons.

For example, to display a checkbox icon, use <code><code> "material_icon": { "name": "check_box" } </code></code>

Google Chat apps:

.google.apps.card.v1.MaterialIcon material_icon = 5;

Returns
Type Description
MaterialIconOrBuilder

getParserForType()

public Parser<Icon> getParserForType()
Returns
Type Description
Parser<Icon>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasIconUrl()

public 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
Type Description
boolean

Whether the iconUrl field is set.

hasKnownIcon()

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

string known_icon = 1;

Returns
Type Description
boolean

Whether the knownIcon field is set.

hasMaterialIcon()

public boolean hasMaterialIcon()

Display one of the Google Material Icons.

For example, to display a checkbox icon, use <code><code> "material_icon": { "name": "check_box" } </code></code>

Google Chat apps:

.google.apps.card.v1.MaterialIcon material_icon = 5;

Returns
Type Description
boolean

Whether the materialIcon field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Icon.Builder newBuilderForType()
Returns
Type Description
Icon.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Icon.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Icon.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Icon.Builder toBuilder()
Returns
Type Description
Icon.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException