Class Message.Builder (0.4.0)

public static final class Message.Builder extends GeneratedMessageV3.Builder<Message.Builder> implements MessageOrBuilder

A message in a Google Chat space.

Protobuf type google.chat.v1.Message

Implements

MessageOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAccessoryWidgets(AccessoryWidget value)

public Message.Builder addAccessoryWidgets(AccessoryWidget value)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameter
NameDescription
valueAccessoryWidget
Returns
TypeDescription
Message.Builder

addAccessoryWidgets(AccessoryWidget.Builder builderForValue)

public Message.Builder addAccessoryWidgets(AccessoryWidget.Builder builderForValue)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameter
NameDescription
builderForValueAccessoryWidget.Builder
Returns
TypeDescription
Message.Builder

addAccessoryWidgets(int index, AccessoryWidget value)

public Message.Builder addAccessoryWidgets(int index, AccessoryWidget value)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameters
NameDescription
indexint
valueAccessoryWidget
Returns
TypeDescription
Message.Builder

addAccessoryWidgets(int index, AccessoryWidget.Builder builderForValue)

public Message.Builder addAccessoryWidgets(int index, AccessoryWidget.Builder builderForValue)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameters
NameDescription
indexint
builderForValueAccessoryWidget.Builder
Returns
TypeDescription
Message.Builder

addAccessoryWidgetsBuilder()

public AccessoryWidget.Builder addAccessoryWidgetsBuilder()

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Returns
TypeDescription
AccessoryWidget.Builder

addAccessoryWidgetsBuilder(int index)

public AccessoryWidget.Builder addAccessoryWidgetsBuilder(int index)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameter
NameDescription
indexint
Returns
TypeDescription
AccessoryWidget.Builder

addAllAccessoryWidgets(Iterable<? extends AccessoryWidget> values)

public Message.Builder addAllAccessoryWidgets(Iterable<? extends AccessoryWidget> values)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameter
NameDescription
valuesIterable<? extends com.google.chat.v1.AccessoryWidget>
Returns
TypeDescription
Message.Builder

addAllAnnotations(Iterable<? extends Annotation> values)

public Message.Builder addAllAnnotations(Iterable<? extends Annotation> values)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuesIterable<? extends com.google.chat.v1.Annotation>
Returns
TypeDescription
Message.Builder

addAllAttachedGifs(Iterable<? extends AttachedGif> values)

public Message.Builder addAllAttachedGifs(Iterable<? extends AttachedGif> values)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuesIterable<? extends com.google.chat.v1.AttachedGif>
Returns
TypeDescription
Message.Builder

addAllAttachment(Iterable<? extends Attachment> values)

public Message.Builder addAllAttachment(Iterable<? extends Attachment> values)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameter
NameDescription
valuesIterable<? extends com.google.chat.v1.Attachment>
Returns
TypeDescription
Message.Builder

addAllCards(Iterable<? extends ContextualAddOnMarkup.Card> values) (deprecated)

public Message.Builder addAllCards(Iterable<? extends ContextualAddOnMarkup.Card> values)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameter
NameDescription
valuesIterable<? extends com.google.chat.v1.ContextualAddOnMarkup.Card>
Returns
TypeDescription
Message.Builder

addAllCardsV2(Iterable<? extends CardWithId> values)

public Message.Builder addAllCardsV2(Iterable<? extends CardWithId> values)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameter
NameDescription
valuesIterable<? extends com.google.chat.v1.CardWithId>
Returns
TypeDescription
Message.Builder

addAllEmojiReactionSummaries(Iterable<? extends EmojiReactionSummary> values)

public Message.Builder addAllEmojiReactionSummaries(Iterable<? extends EmojiReactionSummary> values)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuesIterable<? extends com.google.chat.v1.EmojiReactionSummary>
Returns
TypeDescription
Message.Builder

addAnnotations(Annotation value)

public Message.Builder addAnnotations(Annotation value)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueAnnotation
Returns
TypeDescription
Message.Builder

addAnnotations(Annotation.Builder builderForValue)

public Message.Builder addAnnotations(Annotation.Builder builderForValue)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueAnnotation.Builder
Returns
TypeDescription
Message.Builder

addAnnotations(int index, Annotation value)

public Message.Builder addAnnotations(int index, Annotation value)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueAnnotation
Returns
TypeDescription
Message.Builder

addAnnotations(int index, Annotation.Builder builderForValue)

public Message.Builder addAnnotations(int index, Annotation.Builder builderForValue)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueAnnotation.Builder
Returns
TypeDescription
Message.Builder

addAnnotationsBuilder()

public Annotation.Builder addAnnotationsBuilder()

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Annotation.Builder

addAnnotationsBuilder(int index)

public Annotation.Builder addAnnotationsBuilder(int index)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Annotation.Builder

addAttachedGifs(AttachedGif value)

public Message.Builder addAttachedGifs(AttachedGif value)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueAttachedGif
Returns
TypeDescription
Message.Builder

addAttachedGifs(AttachedGif.Builder builderForValue)

public Message.Builder addAttachedGifs(AttachedGif.Builder builderForValue)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueAttachedGif.Builder
Returns
TypeDescription
Message.Builder

addAttachedGifs(int index, AttachedGif value)

public Message.Builder addAttachedGifs(int index, AttachedGif value)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueAttachedGif
Returns
TypeDescription
Message.Builder

addAttachedGifs(int index, AttachedGif.Builder builderForValue)

public Message.Builder addAttachedGifs(int index, AttachedGif.Builder builderForValue)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueAttachedGif.Builder
Returns
TypeDescription
Message.Builder

addAttachedGifsBuilder()

public AttachedGif.Builder addAttachedGifsBuilder()

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
AttachedGif.Builder

addAttachedGifsBuilder(int index)

public AttachedGif.Builder addAttachedGifsBuilder(int index)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
AttachedGif.Builder

addAttachment(Attachment value)

public Message.Builder addAttachment(Attachment value)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameter
NameDescription
valueAttachment
Returns
TypeDescription
Message.Builder

addAttachment(Attachment.Builder builderForValue)

public Message.Builder addAttachment(Attachment.Builder builderForValue)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameter
NameDescription
builderForValueAttachment.Builder
Returns
TypeDescription
Message.Builder

addAttachment(int index, Attachment value)

public Message.Builder addAttachment(int index, Attachment value)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameters
NameDescription
indexint
valueAttachment
Returns
TypeDescription
Message.Builder

addAttachment(int index, Attachment.Builder builderForValue)

public Message.Builder addAttachment(int index, Attachment.Builder builderForValue)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameters
NameDescription
indexint
builderForValueAttachment.Builder
Returns
TypeDescription
Message.Builder

addAttachmentBuilder()

public Attachment.Builder addAttachmentBuilder()

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Returns
TypeDescription
Attachment.Builder

addAttachmentBuilder(int index)

public Attachment.Builder addAttachmentBuilder(int index)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameter
NameDescription
indexint
Returns
TypeDescription
Attachment.Builder

addCards(ContextualAddOnMarkup.Card value) (deprecated)

public Message.Builder addCards(ContextualAddOnMarkup.Card value)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameter
NameDescription
valueContextualAddOnMarkup.Card
Returns
TypeDescription
Message.Builder

addCards(ContextualAddOnMarkup.Card.Builder builderForValue) (deprecated)

public Message.Builder addCards(ContextualAddOnMarkup.Card.Builder builderForValue)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameter
NameDescription
builderForValueContextualAddOnMarkup.Card.Builder
Returns
TypeDescription
Message.Builder

addCards(int index, ContextualAddOnMarkup.Card value) (deprecated)

public Message.Builder addCards(int index, ContextualAddOnMarkup.Card value)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameters
NameDescription
indexint
valueContextualAddOnMarkup.Card
Returns
TypeDescription
Message.Builder

addCards(int index, ContextualAddOnMarkup.Card.Builder builderForValue) (deprecated)

public Message.Builder addCards(int index, ContextualAddOnMarkup.Card.Builder builderForValue)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameters
NameDescription
indexint
builderForValueContextualAddOnMarkup.Card.Builder
Returns
TypeDescription
Message.Builder

addCardsBuilder() (deprecated)

public ContextualAddOnMarkup.Card.Builder addCardsBuilder()

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Returns
TypeDescription
ContextualAddOnMarkup.Card.Builder

addCardsBuilder(int index) (deprecated)

public ContextualAddOnMarkup.Card.Builder addCardsBuilder(int index)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
ContextualAddOnMarkup.Card.Builder

addCardsV2(CardWithId value)

public Message.Builder addCardsV2(CardWithId value)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameter
NameDescription
valueCardWithId
Returns
TypeDescription
Message.Builder

addCardsV2(CardWithId.Builder builderForValue)

public Message.Builder addCardsV2(CardWithId.Builder builderForValue)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameter
NameDescription
builderForValueCardWithId.Builder
Returns
TypeDescription
Message.Builder

addCardsV2(int index, CardWithId value)

public Message.Builder addCardsV2(int index, CardWithId value)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameters
NameDescription
indexint
valueCardWithId
Returns
TypeDescription
Message.Builder

addCardsV2(int index, CardWithId.Builder builderForValue)

public Message.Builder addCardsV2(int index, CardWithId.Builder builderForValue)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameters
NameDescription
indexint
builderForValueCardWithId.Builder
Returns
TypeDescription
Message.Builder

addCardsV2Builder()

public CardWithId.Builder addCardsV2Builder()

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Returns
TypeDescription
CardWithId.Builder

addCardsV2Builder(int index)

public CardWithId.Builder addCardsV2Builder(int index)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameter
NameDescription
indexint
Returns
TypeDescription
CardWithId.Builder

addEmojiReactionSummaries(EmojiReactionSummary value)

public Message.Builder addEmojiReactionSummaries(EmojiReactionSummary value)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueEmojiReactionSummary
Returns
TypeDescription
Message.Builder

addEmojiReactionSummaries(EmojiReactionSummary.Builder builderForValue)

public Message.Builder addEmojiReactionSummaries(EmojiReactionSummary.Builder builderForValue)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueEmojiReactionSummary.Builder
Returns
TypeDescription
Message.Builder

addEmojiReactionSummaries(int index, EmojiReactionSummary value)

public Message.Builder addEmojiReactionSummaries(int index, EmojiReactionSummary value)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueEmojiReactionSummary
Returns
TypeDescription
Message.Builder

addEmojiReactionSummaries(int index, EmojiReactionSummary.Builder builderForValue)

public Message.Builder addEmojiReactionSummaries(int index, EmojiReactionSummary.Builder builderForValue)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueEmojiReactionSummary.Builder
Returns
TypeDescription
Message.Builder

addEmojiReactionSummariesBuilder()

public EmojiReactionSummary.Builder addEmojiReactionSummariesBuilder()

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EmojiReactionSummary.Builder

addEmojiReactionSummariesBuilder(int index)

public EmojiReactionSummary.Builder addEmojiReactionSummariesBuilder(int index)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
EmojiReactionSummary.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Message.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Message.Builder
Overrides

build()

public Message build()
Returns
TypeDescription
Message

buildPartial()

public Message buildPartial()
Returns
TypeDescription
Message

clear()

public Message.Builder clear()
Returns
TypeDescription
Message.Builder
Overrides

clearAccessoryWidgets()

public Message.Builder clearAccessoryWidgets()

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Returns
TypeDescription
Message.Builder

clearActionResponse()

public Message.Builder clearActionResponse()

Input only. Parameters that a Chat app can use to configure how its response is posted.

.google.chat.v1.ActionResponse action_response = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearAnnotations()

public Message.Builder clearAnnotations()

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearArgumentText()

public Message.Builder clearArgumentText()

Output only. Plain-text body of the message with all Chat app mentions stripped out.

string argument_text = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

This builder for chaining.

clearAttachedGifs()

public Message.Builder clearAttachedGifs()

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearAttachment()

public Message.Builder clearAttachment()

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Returns
TypeDescription
Message.Builder

clearCards() (deprecated)

public Message.Builder clearCards()

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Returns
TypeDescription
Message.Builder

clearCardsV2()

public Message.Builder clearCardsV2()

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Returns
TypeDescription
Message.Builder

clearClientAssignedMessageId()

public Message.Builder clearClientAssignedMessageId()

Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the messageId field when you create the message. For details, see Name a message.

string client_assigned_message_id = 32;

Returns
TypeDescription
Message.Builder

This builder for chaining.

clearCreateTime()

public Message.Builder clearCreateTime()

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Message.Builder

clearDeleteTime()

public Message.Builder clearDeleteTime()

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

.google.protobuf.Timestamp delete_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearDeletionMetadata()

public Message.Builder clearDeletionMetadata()

Output only. Information about a deleted message. A message is deleted when delete_time is set.

.google.chat.v1.DeletionMetadata deletion_metadata = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearEmojiReactionSummaries()

public Message.Builder clearEmojiReactionSummaries()

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearFallbackText()

public Message.Builder clearFallbackText()

A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.

string fallback_text = 13;

Returns
TypeDescription
Message.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Message.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Message.Builder
Overrides

clearFormattedText()

public Message.Builder clearFormattedText()

Output only. Contains the message text with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following:

  • Markup syntax for bold, italic, strikethrough, monospace, and monospace block.

  • User mentions using the format <users/{user}>.

  • Custom hyperlinks using the format <{url}|{rendered_text}> where the first string is the URL and the second is the rendered text—for example, <http://example.com|custom text>.

  • Custom emoji using the format :{emoji_name}:—for example, 😄. This doesn't apply to Unicode emoji, such as U+1F600 for a grinning face emoji.

    For more information, see View text formatting sent in a message

string formatted_text = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

This builder for chaining.

clearLastUpdateTime()

public Message.Builder clearLastUpdateTime()

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

.google.protobuf.Timestamp last_update_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearMatchedUrl()

public Message.Builder clearMatchedUrl()

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

.google.chat.v1.MatchedUrl matched_url = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearName()

public Message.Builder clearName()

Resource name of the message.

Format: spaces/{space}/messages/{message}

Where {space} is the ID of the space where the message is posted and {message} is a system-assigned ID for the message. For example, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing {message} with the value from the clientAssignedMessageId field. For example, spaces/AAAAAAAAAAA/messages/client-custom-name. For details, see Name a message.

string name = 1;

Returns
TypeDescription
Message.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Message.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Message.Builder
Overrides

clearPrivateMessageViewer()

public Message.Builder clearPrivateMessageViewer()

Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages.

Only Chat apps can send private messages. If your Chat app authenticates as a user to send a message, the message can't be private and must omit this field.

For details, see Send private messages to Google Chat users.

.google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
Message.Builder

clearQuotedMessageMetadata()

public Message.Builder clearQuotedMessageMetadata()

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

.google.chat.v1.QuotedMessageMetadata quoted_message_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearSender()

public Message.Builder clearSender()

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

.google.chat.v1.User sender = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearSlashCommand()

public Message.Builder clearSlashCommand()

Output only. Slash command information, if applicable.

.google.chat.v1.SlashCommand slash_command = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

clearSpace()

public Message.Builder clearSpace()

If your Chat app authenticates as a user, the output populates the space name.

.google.chat.v1.Space space = 12;

Returns
TypeDescription
Message.Builder

clearText()

public Message.Builder clearText()

Plain-text body of the message. The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user, or everyone in the space.

To learn about creating text messages, see Send a text message.

string text = 4;

Returns
TypeDescription
Message.Builder

This builder for chaining.

clearThread()

public Message.Builder clearThread()

The thread the message belongs to. For example usage, see Start or reply to a message thread.

.google.chat.v1.Thread thread = 11;

Returns
TypeDescription
Message.Builder

clearThreadReply()

public Message.Builder clearThreadReply()

Output only. When true, the message is a response in a reply thread. When false, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies.

If the space doesn't support reply in threads, this field is always false.

bool thread_reply = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Message.Builder

This builder for chaining.

clone()

public Message.Builder clone()
Returns
TypeDescription
Message.Builder
Overrides

getAccessoryWidgets(int index)

public AccessoryWidget getAccessoryWidgets(int index)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameter
NameDescription
indexint
Returns
TypeDescription
AccessoryWidget

getAccessoryWidgetsBuilder(int index)

public AccessoryWidget.Builder getAccessoryWidgetsBuilder(int index)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameter
NameDescription
indexint
Returns
TypeDescription
AccessoryWidget.Builder

getAccessoryWidgetsBuilderList()

public List<AccessoryWidget.Builder> getAccessoryWidgetsBuilderList()

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Returns
TypeDescription
List<Builder>

getAccessoryWidgetsCount()

public int getAccessoryWidgetsCount()

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Returns
TypeDescription
int

getAccessoryWidgetsList()

public List<AccessoryWidget> getAccessoryWidgetsList()

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Returns
TypeDescription
List<AccessoryWidget>

getAccessoryWidgetsOrBuilder(int index)

public AccessoryWidgetOrBuilder getAccessoryWidgetsOrBuilder(int index)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameter
NameDescription
indexint
Returns
TypeDescription
AccessoryWidgetOrBuilder

getAccessoryWidgetsOrBuilderList()

public List<? extends AccessoryWidgetOrBuilder> getAccessoryWidgetsOrBuilderList()

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Returns
TypeDescription
List<? extends com.google.chat.v1.AccessoryWidgetOrBuilder>

getActionResponse()

public ActionResponse getActionResponse()

Input only. Parameters that a Chat app can use to configure how its response is posted.

.google.chat.v1.ActionResponse action_response = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ActionResponse

The actionResponse.

getActionResponseBuilder()

public ActionResponse.Builder getActionResponseBuilder()

Input only. Parameters that a Chat app can use to configure how its response is posted.

.google.chat.v1.ActionResponse action_response = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ActionResponse.Builder

getActionResponseOrBuilder()

public ActionResponseOrBuilder getActionResponseOrBuilder()

Input only. Parameters that a Chat app can use to configure how its response is posted.

.google.chat.v1.ActionResponse action_response = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ActionResponseOrBuilder

getAnnotations(int index)

public Annotation getAnnotations(int index)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Annotation

getAnnotationsBuilder(int index)

public Annotation.Builder getAnnotationsBuilder(int index)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Annotation.Builder

getAnnotationsBuilderList()

public List<Annotation.Builder> getAnnotationsBuilderList()

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Builder>

getAnnotationsCount()

public int getAnnotationsCount()

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getAnnotationsList()

public List<Annotation> getAnnotationsList()

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Annotation>

getAnnotationsOrBuilder(int index)

public AnnotationOrBuilder getAnnotationsOrBuilder(int index)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
AnnotationOrBuilder

getAnnotationsOrBuilderList()

public List<? extends AnnotationOrBuilder> getAnnotationsOrBuilderList()

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.chat.v1.AnnotationOrBuilder>

getArgumentText()

public String getArgumentText()

Output only. Plain-text body of the message with all Chat app mentions stripped out.

string argument_text = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The argumentText.

getArgumentTextBytes()

public ByteString getArgumentTextBytes()

Output only. Plain-text body of the message with all Chat app mentions stripped out.

string argument_text = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for argumentText.

getAttachedGifs(int index)

public AttachedGif getAttachedGifs(int index)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
AttachedGif

getAttachedGifsBuilder(int index)

public AttachedGif.Builder getAttachedGifsBuilder(int index)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
AttachedGif.Builder

getAttachedGifsBuilderList()

public List<AttachedGif.Builder> getAttachedGifsBuilderList()

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Builder>

getAttachedGifsCount()

public int getAttachedGifsCount()

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getAttachedGifsList()

public List<AttachedGif> getAttachedGifsList()

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<AttachedGif>

getAttachedGifsOrBuilder(int index)

public AttachedGifOrBuilder getAttachedGifsOrBuilder(int index)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
AttachedGifOrBuilder

getAttachedGifsOrBuilderList()

public List<? extends AttachedGifOrBuilder> getAttachedGifsOrBuilderList()

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.chat.v1.AttachedGifOrBuilder>

getAttachment(int index)

public Attachment getAttachment(int index)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameter
NameDescription
indexint
Returns
TypeDescription
Attachment

getAttachmentBuilder(int index)

public Attachment.Builder getAttachmentBuilder(int index)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameter
NameDescription
indexint
Returns
TypeDescription
Attachment.Builder

getAttachmentBuilderList()

public List<Attachment.Builder> getAttachmentBuilderList()

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Returns
TypeDescription
List<Builder>

getAttachmentCount()

public int getAttachmentCount()

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Returns
TypeDescription
int

getAttachmentList()

public List<Attachment> getAttachmentList()

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Returns
TypeDescription
List<Attachment>

getAttachmentOrBuilder(int index)

public AttachmentOrBuilder getAttachmentOrBuilder(int index)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameter
NameDescription
indexint
Returns
TypeDescription
AttachmentOrBuilder

getAttachmentOrBuilderList()

public List<? extends AttachmentOrBuilder> getAttachmentOrBuilderList()

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Returns
TypeDescription
List<? extends com.google.chat.v1.AttachmentOrBuilder>

getCards(int index) (deprecated)

public ContextualAddOnMarkup.Card getCards(int index)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
ContextualAddOnMarkup.Card

getCardsBuilder(int index) (deprecated)

public ContextualAddOnMarkup.Card.Builder getCardsBuilder(int index)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
ContextualAddOnMarkup.Card.Builder

getCardsBuilderList() (deprecated)

public List<ContextualAddOnMarkup.Card.Builder> getCardsBuilderList()

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Returns
TypeDescription
List<Builder>

getCardsCount() (deprecated)

public int getCardsCount()

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Returns
TypeDescription
int

getCardsList() (deprecated)

public List<ContextualAddOnMarkup.Card> getCardsList()

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Returns
TypeDescription
List<Card>

getCardsOrBuilder(int index) (deprecated)

public ContextualAddOnMarkup.CardOrBuilder getCardsOrBuilder(int index)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
ContextualAddOnMarkup.CardOrBuilder

getCardsOrBuilderList() (deprecated)

public List<? extends ContextualAddOnMarkup.CardOrBuilder> getCardsOrBuilderList()

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Returns
TypeDescription
List<? extends com.google.chat.v1.ContextualAddOnMarkup.CardOrBuilder>

getCardsV2(int index)

public CardWithId getCardsV2(int index)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameter
NameDescription
indexint
Returns
TypeDescription
CardWithId

getCardsV2Builder(int index)

public CardWithId.Builder getCardsV2Builder(int index)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameter
NameDescription
indexint
Returns
TypeDescription
CardWithId.Builder

getCardsV2BuilderList()

public List<CardWithId.Builder> getCardsV2BuilderList()

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Returns
TypeDescription
List<Builder>

getCardsV2Count()

public int getCardsV2Count()

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Returns
TypeDescription
int

getCardsV2List()

public List<CardWithId> getCardsV2List()

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Returns
TypeDescription
List<CardWithId>

getCardsV2OrBuilder(int index)

public CardWithIdOrBuilder getCardsV2OrBuilder(int index)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameter
NameDescription
indexint
Returns
TypeDescription
CardWithIdOrBuilder

getCardsV2OrBuilderList()

public List<? extends CardWithIdOrBuilder> getCardsV2OrBuilderList()

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Returns
TypeDescription
List<? extends com.google.chat.v1.CardWithIdOrBuilder>

getClientAssignedMessageId()

public String getClientAssignedMessageId()

Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the messageId field when you create the message. For details, see Name a message.

string client_assigned_message_id = 32;

Returns
TypeDescription
String

The clientAssignedMessageId.

getClientAssignedMessageIdBytes()

public ByteString getClientAssignedMessageIdBytes()

Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the messageId field when you create the message. For details, see Name a message.

string client_assigned_message_id = 32;

Returns
TypeDescription
ByteString

The bytes for clientAssignedMessageId.

getCreateTime()

public Timestamp getCreateTime()

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Message getDefaultInstanceForType()
Returns
TypeDescription
Message

getDeleteTime()

public Timestamp getDeleteTime()

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

.google.protobuf.Timestamp delete_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

.google.protobuf.Timestamp delete_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

.google.protobuf.Timestamp delete_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDeletionMetadata()

public DeletionMetadata getDeletionMetadata()

Output only. Information about a deleted message. A message is deleted when delete_time is set.

.google.chat.v1.DeletionMetadata deletion_metadata = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DeletionMetadata

The deletionMetadata.

getDeletionMetadataBuilder()

public DeletionMetadata.Builder getDeletionMetadataBuilder()

Output only. Information about a deleted message. A message is deleted when delete_time is set.

.google.chat.v1.DeletionMetadata deletion_metadata = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DeletionMetadata.Builder

getDeletionMetadataOrBuilder()

public DeletionMetadataOrBuilder getDeletionMetadataOrBuilder()

Output only. Information about a deleted message. A message is deleted when delete_time is set.

.google.chat.v1.DeletionMetadata deletion_metadata = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DeletionMetadataOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEmojiReactionSummaries(int index)

public EmojiReactionSummary getEmojiReactionSummaries(int index)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
EmojiReactionSummary

getEmojiReactionSummariesBuilder(int index)

public EmojiReactionSummary.Builder getEmojiReactionSummariesBuilder(int index)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
EmojiReactionSummary.Builder

getEmojiReactionSummariesBuilderList()

public List<EmojiReactionSummary.Builder> getEmojiReactionSummariesBuilderList()

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Builder>

getEmojiReactionSummariesCount()

public int getEmojiReactionSummariesCount()

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getEmojiReactionSummariesList()

public List<EmojiReactionSummary> getEmojiReactionSummariesList()

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<EmojiReactionSummary>

getEmojiReactionSummariesOrBuilder(int index)

public EmojiReactionSummaryOrBuilder getEmojiReactionSummariesOrBuilder(int index)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
EmojiReactionSummaryOrBuilder

getEmojiReactionSummariesOrBuilderList()

public List<? extends EmojiReactionSummaryOrBuilder> getEmojiReactionSummariesOrBuilderList()

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.chat.v1.EmojiReactionSummaryOrBuilder>

getFallbackText()

public String getFallbackText()

A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.

string fallback_text = 13;

Returns
TypeDescription
String

The fallbackText.

getFallbackTextBytes()

public ByteString getFallbackTextBytes()

A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.

string fallback_text = 13;

Returns
TypeDescription
ByteString

The bytes for fallbackText.

getFormattedText()

public String getFormattedText()

Output only. Contains the message text with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following:

  • Markup syntax for bold, italic, strikethrough, monospace, and monospace block.

  • User mentions using the format <users/{user}>.

  • Custom hyperlinks using the format <{url}|{rendered_text}> where the first string is the URL and the second is the rendered text—for example, <http://example.com|custom text>.

  • Custom emoji using the format :{emoji_name}:—for example, 😄. This doesn't apply to Unicode emoji, such as U+1F600 for a grinning face emoji.

    For more information, see View text formatting sent in a message

string formatted_text = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The formattedText.

getFormattedTextBytes()

public ByteString getFormattedTextBytes()

Output only. Contains the message text with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following:

  • Markup syntax for bold, italic, strikethrough, monospace, and monospace block.

  • User mentions using the format <users/{user}>.

  • Custom hyperlinks using the format <{url}|{rendered_text}> where the first string is the URL and the second is the rendered text—for example, <http://example.com|custom text>.

  • Custom emoji using the format :{emoji_name}:—for example, 😄. This doesn't apply to Unicode emoji, such as U+1F600 for a grinning face emoji.

    For more information, see View text formatting sent in a message

string formatted_text = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for formattedText.

getLastUpdateTime()

public Timestamp getLastUpdateTime()

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

.google.protobuf.Timestamp last_update_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The lastUpdateTime.

getLastUpdateTimeBuilder()

public Timestamp.Builder getLastUpdateTimeBuilder()

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

.google.protobuf.Timestamp last_update_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getLastUpdateTimeOrBuilder()

public TimestampOrBuilder getLastUpdateTimeOrBuilder()

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

.google.protobuf.Timestamp last_update_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getMatchedUrl()

public MatchedUrl getMatchedUrl()

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

.google.chat.v1.MatchedUrl matched_url = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
MatchedUrl

The matchedUrl.

getMatchedUrlBuilder()

public MatchedUrl.Builder getMatchedUrlBuilder()

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

.google.chat.v1.MatchedUrl matched_url = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
MatchedUrl.Builder

getMatchedUrlOrBuilder()

public MatchedUrlOrBuilder getMatchedUrlOrBuilder()

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

.google.chat.v1.MatchedUrl matched_url = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
MatchedUrlOrBuilder

getName()

public String getName()

Resource name of the message.

Format: spaces/{space}/messages/{message}

Where {space} is the ID of the space where the message is posted and {message} is a system-assigned ID for the message. For example, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing {message} with the value from the clientAssignedMessageId field. For example, spaces/AAAAAAAAAAA/messages/client-custom-name. For details, see Name a message.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Resource name of the message.

Format: spaces/{space}/messages/{message}

Where {space} is the ID of the space where the message is posted and {message} is a system-assigned ID for the message. For example, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing {message} with the value from the clientAssignedMessageId field. For example, spaces/AAAAAAAAAAA/messages/client-custom-name. For details, see Name a message.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getPrivateMessageViewer()

public User getPrivateMessageViewer()

Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages.

Only Chat apps can send private messages. If your Chat app authenticates as a user to send a message, the message can't be private and must omit this field.

For details, see Send private messages to Google Chat users.

.google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
User

The privateMessageViewer.

getPrivateMessageViewerBuilder()

public User.Builder getPrivateMessageViewerBuilder()

Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages.

Only Chat apps can send private messages. If your Chat app authenticates as a user to send a message, the message can't be private and must omit this field.

For details, see Send private messages to Google Chat users.

.google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
User.Builder

getPrivateMessageViewerOrBuilder()

public UserOrBuilder getPrivateMessageViewerOrBuilder()

Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages.

Only Chat apps can send private messages. If your Chat app authenticates as a user to send a message, the message can't be private and must omit this field.

For details, see Send private messages to Google Chat users.

.google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
UserOrBuilder

getQuotedMessageMetadata()

public QuotedMessageMetadata getQuotedMessageMetadata()

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

.google.chat.v1.QuotedMessageMetadata quoted_message_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
QuotedMessageMetadata

The quotedMessageMetadata.

getQuotedMessageMetadataBuilder()

public QuotedMessageMetadata.Builder getQuotedMessageMetadataBuilder()

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

.google.chat.v1.QuotedMessageMetadata quoted_message_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
QuotedMessageMetadata.Builder

getQuotedMessageMetadataOrBuilder()

public QuotedMessageMetadataOrBuilder getQuotedMessageMetadataOrBuilder()

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

.google.chat.v1.QuotedMessageMetadata quoted_message_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
QuotedMessageMetadataOrBuilder

getSender()

public User getSender()

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

.google.chat.v1.User sender = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
User

The sender.

getSenderBuilder()

public User.Builder getSenderBuilder()

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

.google.chat.v1.User sender = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
User.Builder

getSenderOrBuilder()

public UserOrBuilder getSenderOrBuilder()

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

.google.chat.v1.User sender = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
UserOrBuilder

getSlashCommand()

public SlashCommand getSlashCommand()

Output only. Slash command information, if applicable.

.google.chat.v1.SlashCommand slash_command = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SlashCommand

The slashCommand.

getSlashCommandBuilder()

public SlashCommand.Builder getSlashCommandBuilder()

Output only. Slash command information, if applicable.

.google.chat.v1.SlashCommand slash_command = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SlashCommand.Builder

getSlashCommandOrBuilder()

public SlashCommandOrBuilder getSlashCommandOrBuilder()

Output only. Slash command information, if applicable.

.google.chat.v1.SlashCommand slash_command = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SlashCommandOrBuilder

getSpace()

public Space getSpace()

If your Chat app authenticates as a user, the output populates the space name.

.google.chat.v1.Space space = 12;

Returns
TypeDescription
Space

The space.

getSpaceBuilder()

public Space.Builder getSpaceBuilder()

If your Chat app authenticates as a user, the output populates the space name.

.google.chat.v1.Space space = 12;

Returns
TypeDescription
Space.Builder

getSpaceOrBuilder()

public SpaceOrBuilder getSpaceOrBuilder()

If your Chat app authenticates as a user, the output populates the space name.

.google.chat.v1.Space space = 12;

Returns
TypeDescription
SpaceOrBuilder

getText()

public String getText()

Plain-text body of the message. The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user, or everyone in the space.

To learn about creating text messages, see Send a text message.

string text = 4;

Returns
TypeDescription
String

The text.

getTextBytes()

public ByteString getTextBytes()

Plain-text body of the message. The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user, or everyone in the space.

To learn about creating text messages, see Send a text message.

string text = 4;

Returns
TypeDescription
ByteString

The bytes for text.

getThread()

public Thread getThread()

The thread the message belongs to. For example usage, see Start or reply to a message thread.

.google.chat.v1.Thread thread = 11;

Returns
TypeDescription
Thread

The thread.

getThreadBuilder()

public Thread.Builder getThreadBuilder()

The thread the message belongs to. For example usage, see Start or reply to a message thread.

.google.chat.v1.Thread thread = 11;

Returns
TypeDescription
Thread.Builder

getThreadOrBuilder()

public ThreadOrBuilder getThreadOrBuilder()

The thread the message belongs to. For example usage, see Start or reply to a message thread.

.google.chat.v1.Thread thread = 11;

Returns
TypeDescription
ThreadOrBuilder

getThreadReply()

public boolean getThreadReply()

Output only. When true, the message is a response in a reply thread. When false, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies.

If the space doesn't support reply in threads, this field is always false.

bool thread_reply = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The threadReply.

hasActionResponse()

public boolean hasActionResponse()

Input only. Parameters that a Chat app can use to configure how its response is posted.

.google.chat.v1.ActionResponse action_response = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
boolean

Whether the actionResponse field is set.

hasCreateTime()

public boolean hasCreateTime()

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

.google.protobuf.Timestamp delete_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the deleteTime field is set.

hasDeletionMetadata()

public boolean hasDeletionMetadata()

Output only. Information about a deleted message. A message is deleted when delete_time is set.

.google.chat.v1.DeletionMetadata deletion_metadata = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the deletionMetadata field is set.

hasLastUpdateTime()

public boolean hasLastUpdateTime()

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

.google.protobuf.Timestamp last_update_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the lastUpdateTime field is set.

hasMatchedUrl()

public boolean hasMatchedUrl()

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

.google.chat.v1.MatchedUrl matched_url = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the matchedUrl field is set.

hasPrivateMessageViewer()

public boolean hasPrivateMessageViewer()

Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages.

Only Chat apps can send private messages. If your Chat app authenticates as a user to send a message, the message can't be private and must omit this field.

For details, see Send private messages to Google Chat users.

.google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
boolean

Whether the privateMessageViewer field is set.

hasQuotedMessageMetadata()

public boolean hasQuotedMessageMetadata()

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

.google.chat.v1.QuotedMessageMetadata quoted_message_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the quotedMessageMetadata field is set.

hasSender()

public boolean hasSender()

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

.google.chat.v1.User sender = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the sender field is set.

hasSlashCommand()

public boolean hasSlashCommand()

Output only. Slash command information, if applicable.

.google.chat.v1.SlashCommand slash_command = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the slashCommand field is set.

hasSpace()

public boolean hasSpace()

If your Chat app authenticates as a user, the output populates the space name.

.google.chat.v1.Space space = 12;

Returns
TypeDescription
boolean

Whether the space field is set.

hasThread()

public boolean hasThread()

The thread the message belongs to. For example usage, see Start or reply to a message thread.

.google.chat.v1.Thread thread = 11;

Returns
TypeDescription
boolean

Whether the thread field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeActionResponse(ActionResponse value)

public Message.Builder mergeActionResponse(ActionResponse value)

Input only. Parameters that a Chat app can use to configure how its response is posted.

.google.chat.v1.ActionResponse action_response = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
NameDescription
valueActionResponse
Returns
TypeDescription
Message.Builder

mergeCreateTime(Timestamp value)

public Message.Builder mergeCreateTime(Timestamp value)

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Message.Builder

mergeDeleteTime(Timestamp value)

public Message.Builder mergeDeleteTime(Timestamp value)

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

.google.protobuf.Timestamp delete_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Message.Builder

mergeDeletionMetadata(DeletionMetadata value)

public Message.Builder mergeDeletionMetadata(DeletionMetadata value)

Output only. Information about a deleted message. A message is deleted when delete_time is set.

.google.chat.v1.DeletionMetadata deletion_metadata = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueDeletionMetadata
Returns
TypeDescription
Message.Builder

mergeFrom(Message other)

public Message.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Message.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Message.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Message.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Message.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Message.Builder
Overrides

mergeLastUpdateTime(Timestamp value)

public Message.Builder mergeLastUpdateTime(Timestamp value)

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

.google.protobuf.Timestamp last_update_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Message.Builder

mergeMatchedUrl(MatchedUrl value)

public Message.Builder mergeMatchedUrl(MatchedUrl value)

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

.google.chat.v1.MatchedUrl matched_url = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueMatchedUrl
Returns
TypeDescription
Message.Builder

mergePrivateMessageViewer(User value)

public Message.Builder mergePrivateMessageViewer(User value)

Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages.

Only Chat apps can send private messages. If your Chat app authenticates as a user to send a message, the message can't be private and must omit this field.

For details, see Send private messages to Google Chat users.

.google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
valueUser
Returns
TypeDescription
Message.Builder

mergeQuotedMessageMetadata(QuotedMessageMetadata value)

public Message.Builder mergeQuotedMessageMetadata(QuotedMessageMetadata value)

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

.google.chat.v1.QuotedMessageMetadata quoted_message_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueQuotedMessageMetadata
Returns
TypeDescription
Message.Builder

mergeSender(User value)

public Message.Builder mergeSender(User value)

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

.google.chat.v1.User sender = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueUser
Returns
TypeDescription
Message.Builder

mergeSlashCommand(SlashCommand value)

public Message.Builder mergeSlashCommand(SlashCommand value)

Output only. Slash command information, if applicable.

.google.chat.v1.SlashCommand slash_command = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueSlashCommand
Returns
TypeDescription
Message.Builder

mergeSpace(Space value)

public Message.Builder mergeSpace(Space value)

If your Chat app authenticates as a user, the output populates the space name.

.google.chat.v1.Space space = 12;

Parameter
NameDescription
valueSpace
Returns
TypeDescription
Message.Builder

mergeThread(Thread value)

public Message.Builder mergeThread(Thread value)

The thread the message belongs to. For example usage, see Start or reply to a message thread.

.google.chat.v1.Thread thread = 11;

Parameter
NameDescription
valueThread
Returns
TypeDescription
Message.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Message.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Message.Builder
Overrides

removeAccessoryWidgets(int index)

public Message.Builder removeAccessoryWidgets(int index)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameter
NameDescription
indexint
Returns
TypeDescription
Message.Builder

removeAnnotations(int index)

public Message.Builder removeAnnotations(int index)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Message.Builder

removeAttachedGifs(int index)

public Message.Builder removeAttachedGifs(int index)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Message.Builder

removeAttachment(int index)

public Message.Builder removeAttachment(int index)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameter
NameDescription
indexint
Returns
TypeDescription
Message.Builder

removeCards(int index) (deprecated)

public Message.Builder removeCards(int index)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
Message.Builder

removeCardsV2(int index)

public Message.Builder removeCardsV2(int index)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameter
NameDescription
indexint
Returns
TypeDescription
Message.Builder

removeEmojiReactionSummaries(int index)

public Message.Builder removeEmojiReactionSummaries(int index)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Message.Builder

setAccessoryWidgets(int index, AccessoryWidget value)

public Message.Builder setAccessoryWidgets(int index, AccessoryWidget value)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameters
NameDescription
indexint
valueAccessoryWidget
Returns
TypeDescription
Message.Builder

setAccessoryWidgets(int index, AccessoryWidget.Builder builderForValue)

public Message.Builder setAccessoryWidgets(int index, AccessoryWidget.Builder builderForValue)

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs.

Creating a message with accessory widgets requires app authentication.

The following example shows a Chat app that uses accessory widgets (thumbs up and thumbs down buttons) in a text message:

!Example accessory widgets message

The JSON for this example message is the following:

<code><code> { "text": "Rate your experience with this Chat app.", "accessoryWidgets": [ { "buttonList": { "buttons": [ { "icon": { "material_icon": { "name": "thumb_up" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doUpvote", } } }, { "icon": { "material_icon": { "name": "thumb_down" } }, "color": { "red": 0, "blue": 255, "green": 0 }, "onClick": { "action": { "function": "doDownvote", } } } ] } } ] } </code></code>

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44;

Parameters
NameDescription
indexint
builderForValueAccessoryWidget.Builder
Returns
TypeDescription
Message.Builder

setActionResponse(ActionResponse value)

public Message.Builder setActionResponse(ActionResponse value)

Input only. Parameters that a Chat app can use to configure how its response is posted.

.google.chat.v1.ActionResponse action_response = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
NameDescription
valueActionResponse
Returns
TypeDescription
Message.Builder

setActionResponse(ActionResponse.Builder builderForValue)

public Message.Builder setActionResponse(ActionResponse.Builder builderForValue)

Input only. Parameters that a Chat app can use to configure how its response is posted.

.google.chat.v1.ActionResponse action_response = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
NameDescription
builderForValueActionResponse.Builder
Returns
TypeDescription
Message.Builder

setAnnotations(int index, Annotation value)

public Message.Builder setAnnotations(int index, Annotation value)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueAnnotation
Returns
TypeDescription
Message.Builder

setAnnotations(int index, Annotation.Builder builderForValue)

public Message.Builder setAnnotations(int index, Annotation.Builder builderForValue)

Output only. Annotations associated with the text in this message.

repeated .google.chat.v1.Annotation annotations = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueAnnotation.Builder
Returns
TypeDescription
Message.Builder

setArgumentText(String value)

public Message.Builder setArgumentText(String value)

Output only. Plain-text body of the message with all Chat app mentions stripped out.

string argument_text = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The argumentText to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setArgumentTextBytes(ByteString value)

public Message.Builder setArgumentTextBytes(ByteString value)

Output only. Plain-text body of the message with all Chat app mentions stripped out.

string argument_text = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for argumentText to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setAttachedGifs(int index, AttachedGif value)

public Message.Builder setAttachedGifs(int index, AttachedGif value)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueAttachedGif
Returns
TypeDescription
Message.Builder

setAttachedGifs(int index, AttachedGif.Builder builderForValue)

public Message.Builder setAttachedGifs(int index, AttachedGif.Builder builderForValue)

Output only. GIF images that are attached to the message.

repeated .google.chat.v1.AttachedGif attached_gifs = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueAttachedGif.Builder
Returns
TypeDescription
Message.Builder

setAttachment(int index, Attachment value)

public Message.Builder setAttachment(int index, Attachment value)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameters
NameDescription
indexint
valueAttachment
Returns
TypeDescription
Message.Builder

setAttachment(int index, Attachment.Builder builderForValue)

public Message.Builder setAttachment(int index, Attachment.Builder builderForValue)

User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18;

Parameters
NameDescription
indexint
builderForValueAttachment.Builder
Returns
TypeDescription
Message.Builder

setCards(int index, ContextualAddOnMarkup.Card value) (deprecated)

public Message.Builder setCards(int index, ContextualAddOnMarkup.Card value)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameters
NameDescription
indexint
valueContextualAddOnMarkup.Card
Returns
TypeDescription
Message.Builder

setCards(int index, ContextualAddOnMarkup.Card.Builder builderForValue) (deprecated)

public Message.Builder setCards(int index, ContextualAddOnMarkup.Card.Builder builderForValue)

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

repeated .google.chat.v1.ContextualAddOnMarkup.Card cards = 5 [deprecated = true];

Parameters
NameDescription
indexint
builderForValueContextualAddOnMarkup.Card.Builder
Returns
TypeDescription
Message.Builder

setCardsV2(int index, CardWithId value)

public Message.Builder setCardsV2(int index, CardWithId value)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameters
NameDescription
indexint
valueCardWithId
Returns
TypeDescription
Message.Builder

setCardsV2(int index, CardWithId.Builder builderForValue)

public Message.Builder setCardsV2(int index, CardWithId.Builder builderForValue)

An array of cards.

Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards.

To learn about cards and how to create them, see Design dynamic, interactive, and consistent UIs with cards.

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22;

Parameters
NameDescription
indexint
builderForValueCardWithId.Builder
Returns
TypeDescription
Message.Builder

setClientAssignedMessageId(String value)

public Message.Builder setClientAssignedMessageId(String value)

Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the messageId field when you create the message. For details, see Name a message.

string client_assigned_message_id = 32;

Parameter
NameDescription
valueString

The clientAssignedMessageId to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setClientAssignedMessageIdBytes(ByteString value)

public Message.Builder setClientAssignedMessageIdBytes(ByteString value)

Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the messageId field when you create the message. For details, see Name a message.

string client_assigned_message_id = 32;

Parameter
NameDescription
valueByteString

The bytes for clientAssignedMessageId to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Message.Builder setCreateTime(Timestamp value)

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Message.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Message.Builder setCreateTime(Timestamp.Builder builderForValue)

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Message.Builder

setDeleteTime(Timestamp value)

public Message.Builder setDeleteTime(Timestamp value)

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

.google.protobuf.Timestamp delete_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Message.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Message.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.

.google.protobuf.Timestamp delete_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Message.Builder

setDeletionMetadata(DeletionMetadata value)

public Message.Builder setDeletionMetadata(DeletionMetadata value)

Output only. Information about a deleted message. A message is deleted when delete_time is set.

.google.chat.v1.DeletionMetadata deletion_metadata = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueDeletionMetadata
Returns
TypeDescription
Message.Builder

setDeletionMetadata(DeletionMetadata.Builder builderForValue)

public Message.Builder setDeletionMetadata(DeletionMetadata.Builder builderForValue)

Output only. Information about a deleted message. A message is deleted when delete_time is set.

.google.chat.v1.DeletionMetadata deletion_metadata = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueDeletionMetadata.Builder
Returns
TypeDescription
Message.Builder

setEmojiReactionSummaries(int index, EmojiReactionSummary value)

public Message.Builder setEmojiReactionSummaries(int index, EmojiReactionSummary value)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueEmojiReactionSummary
Returns
TypeDescription
Message.Builder

setEmojiReactionSummaries(int index, EmojiReactionSummary.Builder builderForValue)

public Message.Builder setEmojiReactionSummaries(int index, EmojiReactionSummary.Builder builderForValue)

Output only. The list of emoji reaction summaries on the message.

repeated .google.chat.v1.EmojiReactionSummary emoji_reaction_summaries = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueEmojiReactionSummary.Builder
Returns
TypeDescription
Message.Builder

setFallbackText(String value)

public Message.Builder setFallbackText(String value)

A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.

string fallback_text = 13;

Parameter
NameDescription
valueString

The fallbackText to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setFallbackTextBytes(ByteString value)

public Message.Builder setFallbackTextBytes(ByteString value)

A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.

string fallback_text = 13;

Parameter
NameDescription
valueByteString

The bytes for fallbackText to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Message.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Message.Builder
Overrides

setFormattedText(String value)

public Message.Builder setFormattedText(String value)

Output only. Contains the message text with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following:

  • Markup syntax for bold, italic, strikethrough, monospace, and monospace block.

  • User mentions using the format <users/{user}>.

  • Custom hyperlinks using the format <{url}|{rendered_text}> where the first string is the URL and the second is the rendered text—for example, <http://example.com|custom text>.

  • Custom emoji using the format :{emoji_name}:—for example, 😄. This doesn't apply to Unicode emoji, such as U+1F600 for a grinning face emoji.

    For more information, see View text formatting sent in a message

string formatted_text = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The formattedText to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setFormattedTextBytes(ByteString value)

public Message.Builder setFormattedTextBytes(ByteString value)

Output only. Contains the message text with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following:

  • Markup syntax for bold, italic, strikethrough, monospace, and monospace block.

  • User mentions using the format <users/{user}>.

  • Custom hyperlinks using the format <{url}|{rendered_text}> where the first string is the URL and the second is the rendered text—for example, <http://example.com|custom text>.

  • Custom emoji using the format :{emoji_name}:—for example, 😄. This doesn't apply to Unicode emoji, such as U+1F600 for a grinning face emoji.

    For more information, see View text formatting sent in a message

string formatted_text = 43 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for formattedText to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setLastUpdateTime(Timestamp value)

public Message.Builder setLastUpdateTime(Timestamp value)

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

.google.protobuf.Timestamp last_update_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Message.Builder

setLastUpdateTime(Timestamp.Builder builderForValue)

public Message.Builder setLastUpdateTime(Timestamp.Builder builderForValue)

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.

.google.protobuf.Timestamp last_update_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Message.Builder

setMatchedUrl(MatchedUrl value)

public Message.Builder setMatchedUrl(MatchedUrl value)

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

.google.chat.v1.MatchedUrl matched_url = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueMatchedUrl
Returns
TypeDescription
Message.Builder

setMatchedUrl(MatchedUrl.Builder builderForValue)

public Message.Builder setMatchedUrl(MatchedUrl.Builder builderForValue)

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links.

.google.chat.v1.MatchedUrl matched_url = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueMatchedUrl.Builder
Returns
TypeDescription
Message.Builder

setName(String value)

public Message.Builder setName(String value)

Resource name of the message.

Format: spaces/{space}/messages/{message}

Where {space} is the ID of the space where the message is posted and {message} is a system-assigned ID for the message. For example, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing {message} with the value from the clientAssignedMessageId field. For example, spaces/AAAAAAAAAAA/messages/client-custom-name. For details, see Name a message.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Message.Builder setNameBytes(ByteString value)

Resource name of the message.

Format: spaces/{space}/messages/{message}

Where {space} is the ID of the space where the message is posted and {message} is a system-assigned ID for the message. For example, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing {message} with the value from the clientAssignedMessageId field. For example, spaces/AAAAAAAAAAA/messages/client-custom-name. For details, see Name a message.

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setPrivateMessageViewer(User value)

public Message.Builder setPrivateMessageViewer(User value)

Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages.

Only Chat apps can send private messages. If your Chat app authenticates as a user to send a message, the message can't be private and must omit this field.

For details, see Send private messages to Google Chat users.

.google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
valueUser
Returns
TypeDescription
Message.Builder

setPrivateMessageViewer(User.Builder builderForValue)

public Message.Builder setPrivateMessageViewer(User.Builder builderForValue)

Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages.

Only Chat apps can send private messages. If your Chat app authenticates as a user to send a message, the message can't be private and must omit this field.

For details, see Send private messages to Google Chat users.

.google.chat.v1.User private_message_viewer = 36 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
builderForValueUser.Builder
Returns
TypeDescription
Message.Builder

setQuotedMessageMetadata(QuotedMessageMetadata value)

public Message.Builder setQuotedMessageMetadata(QuotedMessageMetadata value)

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

.google.chat.v1.QuotedMessageMetadata quoted_message_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueQuotedMessageMetadata
Returns
TypeDescription
Message.Builder

setQuotedMessageMetadata(QuotedMessageMetadata.Builder builderForValue)

public Message.Builder setQuotedMessageMetadata(QuotedMessageMetadata.Builder builderForValue)

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

.google.chat.v1.QuotedMessageMetadata quoted_message_metadata = 39 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueQuotedMessageMetadata.Builder
Returns
TypeDescription
Message.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Message.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Message.Builder
Overrides

setSender(User value)

public Message.Builder setSender(User value)

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

.google.chat.v1.User sender = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueUser
Returns
TypeDescription
Message.Builder

setSender(User.Builder builderForValue)

public Message.Builder setSender(User.Builder builderForValue)

Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the user name and type.

.google.chat.v1.User sender = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueUser.Builder
Returns
TypeDescription
Message.Builder

setSlashCommand(SlashCommand value)

public Message.Builder setSlashCommand(SlashCommand value)

Output only. Slash command information, if applicable.

.google.chat.v1.SlashCommand slash_command = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueSlashCommand
Returns
TypeDescription
Message.Builder

setSlashCommand(SlashCommand.Builder builderForValue)

public Message.Builder setSlashCommand(SlashCommand.Builder builderForValue)

Output only. Slash command information, if applicable.

.google.chat.v1.SlashCommand slash_command = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueSlashCommand.Builder
Returns
TypeDescription
Message.Builder

setSpace(Space value)

public Message.Builder setSpace(Space value)

If your Chat app authenticates as a user, the output populates the space name.

.google.chat.v1.Space space = 12;

Parameter
NameDescription
valueSpace
Returns
TypeDescription
Message.Builder

setSpace(Space.Builder builderForValue)

public Message.Builder setSpace(Space.Builder builderForValue)

If your Chat app authenticates as a user, the output populates the space name.

.google.chat.v1.Space space = 12;

Parameter
NameDescription
builderForValueSpace.Builder
Returns
TypeDescription
Message.Builder

setText(String value)

public Message.Builder setText(String value)

Plain-text body of the message. The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user, or everyone in the space.

To learn about creating text messages, see Send a text message.

string text = 4;

Parameter
NameDescription
valueString

The text to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setTextBytes(ByteString value)

public Message.Builder setTextBytes(ByteString value)

Plain-text body of the message. The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user, or everyone in the space.

To learn about creating text messages, see Send a text message.

string text = 4;

Parameter
NameDescription
valueByteString

The bytes for text to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setThread(Thread value)

public Message.Builder setThread(Thread value)

The thread the message belongs to. For example usage, see Start or reply to a message thread.

.google.chat.v1.Thread thread = 11;

Parameter
NameDescription
valueThread
Returns
TypeDescription
Message.Builder

setThread(Thread.Builder builderForValue)

public Message.Builder setThread(Thread.Builder builderForValue)

The thread the message belongs to. For example usage, see Start or reply to a message thread.

.google.chat.v1.Thread thread = 11;

Parameter
NameDescription
builderForValueThread.Builder
Returns
TypeDescription
Message.Builder

setThreadReply(boolean value)

public Message.Builder setThreadReply(boolean value)

Output only. When true, the message is a response in a reply thread. When false, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies.

If the space doesn't support reply in threads, this field is always false.

bool thread_reply = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueboolean

The threadReply to set.

Returns
TypeDescription
Message.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Message.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Message.Builder
Overrides