Interface DecoratedTextOrBuilder (2.63.1) 

public interface DecoratedTextOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBottomLabel()

public abstract String getBottomLabel()

The text that appears below text. Always wraps.

string bottom_label = 6;

Returns
Type Description
String

The bottomLabel.

getBottomLabelBytes()

public abstract ByteString getBottomLabelBytes()

The text that appears below text. Always wraps.

string bottom_label = 6;

Returns
Type Description
ByteString

The bytes for bottomLabel.

getBottomLabelText()

public abstract TextParagraph getBottomLabelText()

TextParagraph equivalent of bottom_label. Always wraps. Allows for more complex formatting than bottom_label.

Google Chat apps:

.google.apps.card.v1.TextParagraph bottom_label_text = 19;

Returns
Type Description
TextParagraph

The bottomLabelText.

getBottomLabelTextOrBuilder()

public abstract TextParagraphOrBuilder getBottomLabelTextOrBuilder()

TextParagraph equivalent of bottom_label. Always wraps. Allows for more complex formatting than bottom_label.

Google Chat apps:

.google.apps.card.v1.TextParagraph bottom_label_text = 19;

Returns
Type Description
TextParagraphOrBuilder

getButton()

public abstract Button getButton()

A button that a user can click to trigger an action.

.google.apps.card.v1.Button button = 8;

Returns
Type Description
Button

The button.

getButtonOrBuilder()

public abstract ButtonOrBuilder getButtonOrBuilder()

A button that a user can click to trigger an action.

.google.apps.card.v1.Button button = 8;

Returns
Type Description
ButtonOrBuilder

getContentText()

public abstract TextParagraph getContentText()

TextParagraph equivalent of text. Allows for more complex formatting than text.

Google Chat apps:

.google.apps.card.v1.TextParagraph content_text = 18;

Returns
Type Description
TextParagraph

The contentText.

getContentTextOrBuilder()

public abstract TextParagraphOrBuilder getContentTextOrBuilder()

TextParagraph equivalent of text. Allows for more complex formatting than text.

Google Chat apps:

.google.apps.card.v1.TextParagraph content_text = 18;

Returns
Type Description
TextParagraphOrBuilder

getControlCase()

public abstract DecoratedText.ControlCase getControlCase()
Returns
Type Description
DecoratedText.ControlCase

getEndIcon()

public abstract Icon getEndIcon()

An icon displayed after the text.

Supports built-in and custom icons.

.google.apps.card.v1.Icon end_icon = 11;

Returns
Type Description
Icon

The endIcon.

getEndIconOrBuilder()

public abstract IconOrBuilder getEndIconOrBuilder()

An icon displayed after the text.

Supports built-in and custom icons.

.google.apps.card.v1.Icon end_icon = 11;

Returns
Type Description
IconOrBuilder

getIcon() (deprecated)

public abstract Icon getIcon()

Deprecated. google.apps.card.v1.DecoratedText.icon is deprecated. See google/apps/card/v1/card.proto;l=915

Deprecated in favor of startIcon.

.google.apps.card.v1.Icon icon = 1 [deprecated = true];

Returns
Type Description
Icon

The icon.

getIconOrBuilder() (deprecated)

public abstract IconOrBuilder getIconOrBuilder()

Deprecated in favor of startIcon.

.google.apps.card.v1.Icon icon = 1 [deprecated = true];

Returns
Type Description
IconOrBuilder

getOnClick()

public abstract OnClick getOnClick()

This action is triggered when users click topLabel or bottomLabel.

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

Returns
Type Description
OnClick

The onClick.

getOnClickOrBuilder()

public abstract OnClickOrBuilder getOnClickOrBuilder()

This action is triggered when users click topLabel or bottomLabel.

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

Returns
Type Description
OnClickOrBuilder

getStartIcon()

public abstract Icon getStartIcon()

The icon displayed in front of the text.

.google.apps.card.v1.Icon start_icon = 12;

Returns
Type Description
Icon

The startIcon.

getStartIconOrBuilder()

public abstract IconOrBuilder getStartIconOrBuilder()

The icon displayed in front of the text.

.google.apps.card.v1.Icon start_icon = 12;

Returns
Type Description
IconOrBuilder

getStartIconVerticalAlignment()

public abstract Widget.VerticalAlignment getStartIconVerticalAlignment()

Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered.

Google Chat apps:

.google.apps.card.v1.Widget.VerticalAlignment start_icon_vertical_alignment = 13;

Returns
Type Description
Widget.VerticalAlignment

The startIconVerticalAlignment.

getStartIconVerticalAlignmentValue()

public abstract int getStartIconVerticalAlignmentValue()

Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered.

Google Chat apps:

.google.apps.card.v1.Widget.VerticalAlignment start_icon_vertical_alignment = 13;

Returns
Type Description
int

The enum numeric value on the wire for startIconVerticalAlignment.

getSwitchControl()

public abstract DecoratedText.SwitchControl getSwitchControl()

A switch widget that a user can click to change its state and trigger an action.

.google.apps.card.v1.DecoratedText.SwitchControl switch_control = 9;

Returns
Type Description
DecoratedText.SwitchControl

The switchControl.

getSwitchControlOrBuilder()

public abstract DecoratedText.SwitchControlOrBuilder getSwitchControlOrBuilder()

A switch widget that a user can click to change its state and trigger an action.

.google.apps.card.v1.DecoratedText.SwitchControl switch_control = 9;

Returns
Type Description
DecoratedText.SwitchControlOrBuilder

getText()

public abstract String getText()

Required. The primary text.

Supports simple formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace add-ons.

string text = 4;

Returns
Type Description
String

The text.

getTextBytes()

public abstract ByteString getTextBytes()

Required. The primary text.

Supports simple formatting. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace add-ons.

string text = 4;

Returns
Type Description
ByteString

The bytes for text.

getTopLabel()

public abstract String getTopLabel()

The text that appears above text. Always truncates.

string top_label = 3;

Returns
Type Description
String

The topLabel.

getTopLabelBytes()

public abstract ByteString getTopLabelBytes()

The text that appears above text. Always truncates.

string top_label = 3;

Returns
Type Description
ByteString

The bytes for topLabel.

getTopLabelText()

public abstract TextParagraph getTopLabelText()

TextParagraph equivalent of top_label. Always truncates. Allows for more complex formatting than top_label.

Google Chat apps:

.google.apps.card.v1.TextParagraph top_label_text = 17;

Returns
Type Description
TextParagraph

The topLabelText.

getTopLabelTextOrBuilder()

public abstract TextParagraphOrBuilder getTopLabelTextOrBuilder()

TextParagraph equivalent of top_label. Always truncates. Allows for more complex formatting than top_label.

Google Chat apps:

.google.apps.card.v1.TextParagraph top_label_text = 17;

Returns
Type Description
TextParagraphOrBuilder

getWrapText()

public abstract boolean getWrapText()

The wrap text setting. If true, the text wraps and displays on multiple lines. Otherwise, the text is truncated.

Only applies to text, not topLabel and bottomLabel.

bool wrap_text = 5;

Returns
Type Description
boolean

The wrapText.

hasBottomLabelText()

public abstract boolean hasBottomLabelText()

TextParagraph equivalent of bottom_label. Always wraps. Allows for more complex formatting than bottom_label.

Google Chat apps:

.google.apps.card.v1.TextParagraph bottom_label_text = 19;

Returns
Type Description
boolean

Whether the bottomLabelText field is set.

hasButton()

public abstract boolean hasButton()

A button that a user can click to trigger an action.

.google.apps.card.v1.Button button = 8;

Returns
Type Description
boolean

Whether the button field is set.

hasContentText()

public abstract boolean hasContentText()

TextParagraph equivalent of text. Allows for more complex formatting than text.

Google Chat apps:

.google.apps.card.v1.TextParagraph content_text = 18;

Returns
Type Description
boolean

Whether the contentText field is set.

hasEndIcon()

public abstract boolean hasEndIcon()

An icon displayed after the text.

Supports built-in and custom icons.

.google.apps.card.v1.Icon end_icon = 11;

Returns
Type Description
boolean

Whether the endIcon field is set.

hasIcon() (deprecated)

public abstract boolean hasIcon()

Deprecated. google.apps.card.v1.DecoratedText.icon is deprecated. See google/apps/card/v1/card.proto;l=915

Deprecated in favor of startIcon.

.google.apps.card.v1.Icon icon = 1 [deprecated = true];

Returns
Type Description
boolean

Whether the icon field is set.

hasOnClick()

public abstract boolean hasOnClick()

This action is triggered when users click topLabel or bottomLabel.

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

Returns
Type Description
boolean

Whether the onClick field is set.

hasStartIcon()

public abstract boolean hasStartIcon()

The icon displayed in front of the text.

.google.apps.card.v1.Icon start_icon = 12;

Returns
Type Description
boolean

Whether the startIcon field is set.

hasSwitchControl()

public abstract boolean hasSwitchControl()

A switch widget that a user can click to change its state and trigger an action.

.google.apps.card.v1.DecoratedText.SwitchControl switch_control = 9;

Returns
Type Description
boolean

Whether the switchControl field is set.

hasTopLabelText()

public abstract boolean hasTopLabelText()

TextParagraph equivalent of top_label. Always truncates. Allows for more complex formatting than top_label.

Google Chat apps:

.google.apps.card.v1.TextParagraph top_label_text = 17;

Returns
Type Description
boolean

Whether the topLabelText field is set.