Class Image (2.48.0)

public final class Image extends GeneratedMessageV3 implements ImageOrBuilder

An image that is specified by a URL and can have an onClick action. For an example, see Add an image.

Google Workspace Add-ons and Chat apps:

Protobuf type google.apps.card.v1.Image

Implements

ImageOrBuilder

Static Fields

ALT_TEXT_FIELD_NUMBER

public static final int ALT_TEXT_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_URL_FIELD_NUMBER

public static final int IMAGE_URL_FIELD_NUMBER
Field Value
Type Description
int

ON_CLICK_FIELD_NUMBER

public static final int ON_CLICK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Image getDefaultInstance()
Returns
Type Description
Image

getDescriptor()

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

newBuilder()

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

newBuilder(Image prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAltText()

public String getAltText()

The alternative text of this image that's used for accessibility.

string alt_text = 3;

Returns
Type Description
String

The altText.

getAltTextBytes()

public ByteString getAltTextBytes()

The alternative text of this image that's used for accessibility.

string alt_text = 3;

Returns
Type Description
ByteString

The bytes for altText.

getDefaultInstanceForType()

public Image getDefaultInstanceForType()
Returns
Type Description
Image

getImageUrl()

public String getImageUrl()

The HTTPS URL that hosts the image.

For example:

<code><code> https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png </code></code>

string image_url = 1;

Returns
Type Description
String

The imageUrl.

getImageUrlBytes()

public ByteString getImageUrlBytes()

The HTTPS URL that hosts the image.

For example:

<code><code> https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png </code></code>

string image_url = 1;

Returns
Type Description
ByteString

The bytes for imageUrl.

getOnClick()

public OnClick getOnClick()

When a user clicks the image, the click triggers this action.

.google.apps.card.v1.OnClick on_click = 2;

Returns
Type Description
OnClick

The onClick.

getOnClickOrBuilder()

public OnClickOrBuilder getOnClickOrBuilder()

When a user clicks the image, the click triggers this action.

.google.apps.card.v1.OnClick on_click = 2;

Returns
Type Description
OnClickOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasOnClick()

public boolean hasOnClick()

When a user clicks the image, the click triggers this action.

.google.apps.card.v1.OnClick on_click = 2;

Returns
Type Description
boolean

Whether the onClick 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 Image.Builder newBuilderForType()
Returns
Type Description
Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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