Class WidgetMarkup.KeyValue (0.19.0) 

public static final class WidgetMarkup.KeyValue extends GeneratedMessageV3 implements WidgetMarkup.KeyValueOrBuilder

A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

Protobuf type google.chat.v1.WidgetMarkup.KeyValue

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > WidgetMarkup.KeyValue

Static Fields

BOTTOM_LABEL_FIELD_NUMBER

public static final int BOTTOM_LABEL_FIELD_NUMBER
Field Value
Type Description
int

BUTTON_FIELD_NUMBER

public static final int BUTTON_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_MULTILINE_FIELD_NUMBER

public static final int CONTENT_MULTILINE_FIELD_NUMBER
Field Value
Type Description
int

ICON_FIELD_NUMBER

public static final int ICON_FIELD_NUMBER
Field Value
Type Description
int

ICON_URL_FIELD_NUMBER

public static final int ICON_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

TOP_LABEL_FIELD_NUMBER

public static final int TOP_LABEL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WidgetMarkup.KeyValue getDefaultInstance()
Returns
Type Description
WidgetMarkup.KeyValue

getDescriptor()

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

newBuilder()

public static WidgetMarkup.KeyValue.Builder newBuilder()
Returns
Type Description
WidgetMarkup.KeyValue.Builder

newBuilder(WidgetMarkup.KeyValue prototype)

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

parseDelimitedFrom(InputStream input)

public static WidgetMarkup.KeyValue parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WidgetMarkup.KeyValue
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static WidgetMarkup.KeyValue parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WidgetMarkup.KeyValue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static WidgetMarkup.KeyValue parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WidgetMarkup.KeyValue
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static WidgetMarkup.KeyValue parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WidgetMarkup.KeyValue
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static WidgetMarkup.KeyValue parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WidgetMarkup.KeyValue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<WidgetMarkup.KeyValue> parser()
Returns
Type Description
Parser<KeyValue>

Methods

equals(Object obj)

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

getBottomLabel()

public String getBottomLabel()

The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

string bottom_label = 5;

Returns
Type Description
String

The bottomLabel.

getBottomLabelBytes()

public ByteString getBottomLabelBytes()

The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

string bottom_label = 5;

Returns
Type Description
ByteString

The bytes for bottomLabel.

getButton()

public WidgetMarkup.Button getButton()

A button that can be clicked to trigger an action.

.google.chat.v1.WidgetMarkup.Button button = 7;

Returns
Type Description
WidgetMarkup.Button

The button.

getButtonOrBuilder()

public WidgetMarkup.ButtonOrBuilder getButtonOrBuilder()

A button that can be clicked to trigger an action.

.google.chat.v1.WidgetMarkup.Button button = 7;

Returns
Type Description
WidgetMarkup.ButtonOrBuilder

getContent()

public String getContent()

The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

string content = 4;

Returns
Type Description
String

The content.

getContentBytes()

public ByteString getContentBytes()

The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

string content = 4;

Returns
Type Description
ByteString

The bytes for content.

getContentMultiline()

public boolean getContentMultiline()

If the content should be multiline.

bool content_multiline = 9;

Returns
Type Description
boolean

The contentMultiline.

getControlCase()

public WidgetMarkup.KeyValue.ControlCase getControlCase()
Returns
Type Description
WidgetMarkup.KeyValue.ControlCase

getDefaultInstanceForType()

public WidgetMarkup.KeyValue getDefaultInstanceForType()
Returns
Type Description
WidgetMarkup.KeyValue

getIcon()

public WidgetMarkup.Icon getIcon()

An enum value that's replaced by the Chat API with the corresponding icon image.

.google.chat.v1.WidgetMarkup.Icon icon = 1;

Returns
Type Description
WidgetMarkup.Icon

The icon.

getIconUrl()

public String getIconUrl()

The icon specified by a URL.

string icon_url = 2;

Returns
Type Description
String

The iconUrl.

getIconUrlBytes()

public ByteString getIconUrlBytes()

The icon specified by a URL.

string icon_url = 2;

Returns
Type Description
ByteString

The bytes for iconUrl.

getIconValue()

public int getIconValue()

An enum value that's replaced by the Chat API with the corresponding icon image.

.google.chat.v1.WidgetMarkup.Icon icon = 1;

Returns
Type Description
int

The enum numeric value on the wire for icon.

getIconsCase()

public WidgetMarkup.KeyValue.IconsCase getIconsCase()
Returns
Type Description
WidgetMarkup.KeyValue.IconsCase

getOnClick()

public WidgetMarkup.OnClick getOnClick()

The onclick action. Only the top label, bottom label, and content region are clickable.

.google.chat.v1.WidgetMarkup.OnClick on_click = 6;

Returns
Type Description
WidgetMarkup.OnClick

The onClick.

getOnClickOrBuilder()

public WidgetMarkup.OnClickOrBuilder getOnClickOrBuilder()

The onclick action. Only the top label, bottom label, and content region are clickable.

.google.chat.v1.WidgetMarkup.OnClick on_click = 6;

Returns
Type Description
WidgetMarkup.OnClickOrBuilder

getParserForType()

public Parser<WidgetMarkup.KeyValue> getParserForType()
Returns
Type Description
Parser<KeyValue>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTopLabel()

public String getTopLabel()

The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

string top_label = 3;

Returns
Type Description
String

The topLabel.

getTopLabelBytes()

public ByteString getTopLabelBytes()

The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

string top_label = 3;

Returns
Type Description
ByteString

The bytes for topLabel.

hasButton()

public boolean hasButton()

A button that can be clicked to trigger an action.

.google.chat.v1.WidgetMarkup.Button button = 7;

Returns
Type Description
boolean

Whether the button field is set.

hasIcon()

public boolean hasIcon()

An enum value that's replaced by the Chat API with the corresponding icon image.

.google.chat.v1.WidgetMarkup.Icon icon = 1;

Returns
Type Description
boolean

Whether the icon field is set.

hasIconUrl()

public boolean hasIconUrl()

The icon specified by a URL.

string icon_url = 2;

Returns
Type Description
boolean

Whether the iconUrl field is set.

hasOnClick()

public boolean hasOnClick()

The onclick action. Only the top label, bottom label, and content region are clickable.

.google.chat.v1.WidgetMarkup.OnClick on_click = 6;

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public WidgetMarkup.KeyValue.Builder toBuilder()
Returns
Type Description
WidgetMarkup.KeyValue.Builder

writeTo(CodedOutputStream output)

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