Class Card.CardHeader (2.40.0)

public static final class Card.CardHeader extends GeneratedMessageV3 implements Card.CardHeaderOrBuilder

Represents a card header. For an example in Google Chat apps, see Add a header.

Google Workspace Add-ons and Chat apps:

Protobuf type google.apps.card.v1.Card.CardHeader

Static Fields

IMAGE_ALT_TEXT_FIELD_NUMBER

public static final int IMAGE_ALT_TEXT_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_TYPE_FIELD_NUMBER

public static final int IMAGE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_URL_FIELD_NUMBER

public static final int IMAGE_URL_FIELD_NUMBER
Field Value
Type Description
int

SUBTITLE_FIELD_NUMBER

public static final int SUBTITLE_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Card.CardHeader getDefaultInstance()
Returns
Type Description
Card.CardHeader

getDescriptor()

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

newBuilder()

public static Card.CardHeader.Builder newBuilder()
Returns
Type Description
Card.CardHeader.Builder

newBuilder(Card.CardHeader prototype)

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

parseDelimitedFrom(InputStream input)

public static Card.CardHeader parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Card.CardHeader
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Card.CardHeader parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Card.CardHeader
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Card.CardHeader parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Card.CardHeader
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Card.CardHeader parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Card.CardHeader
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Card.CardHeader parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Card.CardHeader
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Card.CardHeader> parser()
Returns
Type Description
Parser<CardHeader>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Card.CardHeader getDefaultInstanceForType()
Returns
Type Description
Card.CardHeader

getImageAltText()

public String getImageAltText()

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

string image_alt_text = 5;

Returns
Type Description
String

The imageAltText.

getImageAltTextBytes()

public ByteString getImageAltTextBytes()

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

string image_alt_text = 5;

Returns
Type Description
ByteString

The bytes for imageAltText.

getImageType()

public Widget.ImageType getImageType()

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Widget.ImageType image_type = 3;

Returns
Type Description
Widget.ImageType

The imageType.

getImageTypeValue()

public int getImageTypeValue()

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Widget.ImageType image_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for imageType.

getImageUrl()

public String getImageUrl()

The HTTPS URL of the image in the card header.

string image_url = 4;

Returns
Type Description
String

The imageUrl.

getImageUrlBytes()

public ByteString getImageUrlBytes()

The HTTPS URL of the image in the card header.

string image_url = 4;

Returns
Type Description
ByteString

The bytes for imageUrl.

getParserForType()

public Parser<Card.CardHeader> getParserForType()
Returns
Type Description
Parser<CardHeader>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubtitle()

public String getSubtitle()

The subtitle of the card header. If specified, appears on its own line below the title.

string subtitle = 2;

Returns
Type Description
String

The subtitle.

getSubtitleBytes()

public ByteString getSubtitleBytes()

The subtitle of the card header. If specified, appears on its own line below the title.

string subtitle = 2;

Returns
Type Description
ByteString

The bytes for subtitle.

getTitle()

public String getTitle()

Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

string title = 1;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

string title = 1;

Returns
Type Description
ByteString

The bytes for title.

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 Card.CardHeader.Builder newBuilderForType()
Returns
Type Description
Card.CardHeader.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Card.CardHeader.Builder toBuilder()
Returns
Type Description
Card.CardHeader.Builder

writeTo(CodedOutputStream output)

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