Class Icon (0.1.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 Icon.

Supports built-in and custom icons.

Google Workspace Add-ons and Chat apps:

Protobuf type google.apps.card.v1.Icon

Implements

IconOrBuilder

Static Fields

ALT_TEXT_FIELD_NUMBER

public static final int ALT_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

ICON_URL_FIELD_NUMBER

public static final int ICON_URL_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_TYPE_FIELD_NUMBER

public static final int IMAGE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

KNOWN_ICON_FIELD_NUMBER

public static final int KNOWN_ICON_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Icon getDefaultInstance()
Returns
TypeDescription
Icon

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Icon.Builder newBuilder()
Returns
TypeDescription
Icon.Builder

newBuilder(Icon prototype)

public static Icon.Builder newBuilder(Icon prototype)
Parameter
NameDescription
prototypeIcon
Returns
TypeDescription
Icon.Builder

parseDelimitedFrom(InputStream input)

public static Icon parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Icon
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Icon parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Icon
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Icon parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Icon
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Icon
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Icon parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Icon
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Icon
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Icon parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Icon
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Icon
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Icon parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Icon
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Icon
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Icon parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Icon
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Icon parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Icon
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Icon> parser()
Returns
TypeDescription
Parser<Icon>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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/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
TypeDescription
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/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
TypeDescription
ByteString

The bytes for altText.

getDefaultInstanceForType()

public Icon getDefaultInstanceForType()
Returns
TypeDescription
Icon

getIconUrl()

public String getIconUrl()

Display a custom icon hosted at an HTTPS URL.

For example:

` "iconUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png"

Supported file types include .png and .jpg`.

string icon_url = 2;

Returns
TypeDescription
String

The iconUrl.

getIconUrlBytes()

public ByteString getIconUrlBytes()

Display a custom icon hosted at an HTTPS URL.

For example:

` "iconUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png"

Supported file types include .png and .jpg`.

string icon_url = 2;

Returns
TypeDescription
ByteString

The bytes for iconUrl.

getIconsCase()

public Icon.IconsCase getIconsCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for knownIcon.

getParserForType()

public Parser<Icon> getParserForType()
Returns
TypeDescription
Parser<Icon>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasIconUrl()

public boolean hasIconUrl()

Display a custom icon hosted at an HTTPS URL.

For example:

` "iconUrl": "https://developers.google.com/chat/images/quickstart-app-avatar.png"

Supported file types include .png and .jpg`.

string icon_url = 2;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the knownIcon field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Icon.Builder newBuilderForType()
Returns
TypeDescription
Icon.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Icon.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Icon.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Icon.Builder toBuilder()
Returns
TypeDescription
Icon.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException