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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > IconImplements
IconOrBuilderStatic Fields
ALT_TEXT_FIELD_NUMBER
public
static
final
int
ALT_TEXT_FIELD_NUMBER
ICON_URL_FIELD_NUMBER
public
static
final
int
ICON_URL_FIELD_NUMBER
IMAGE_TYPE_FIELD_NUMBER
public
static
final
int
IMAGE_TYPE_FIELD_NUMBER
KNOWN_ICON_FIELD_NUMBER
public
static
final
int
KNOWN_ICON_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Icon
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Icon
.
Builder
newBuilder
()
newBuilder(Icon prototype)
public
static
Icon
.
Builder
newBuilder
(
Icon
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Icon
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Icon
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Icon
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Icon
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Icon
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Icon
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Icon
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Icon
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Icon
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Icon
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Icon
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Icon
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Icon>
parser
()
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
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;
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;
getDefaultInstanceForType()
public
Icon
getDefaultInstanceForType
()
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;
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;
getIconsCase()
public
Icon
.
IconsCase
getIconsCase
()
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;
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;
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;
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;
getParserForType()
public
Parser<Icon>
getParserForType
()
getSerializedSize()
public
int
getSerializedSize
()
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;
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;
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Icon
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Icon
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
Icon
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
