Class Message (0.27.0)

  public 
  
 final 
  
 class 
 Message 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 MessageOrBuilder 
 

A message in a Google Chat space.

Protobuf type google.chat.v1.Message

Implements

MessageOrBuilder

Static Fields

ACCESSORY_WIDGETS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ACCESSORY_WIDGETS_FIELD_NUMBER 
 
Field Value
Type
Description
int

ACTION_RESPONSE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ACTION_RESPONSE_FIELD_NUMBER 
 
Field Value
Type
Description
int

ANNOTATIONS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ANNOTATIONS_FIELD_NUMBER 
 
Field Value
Type
Description
int

ARGUMENT_TEXT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ARGUMENT_TEXT_FIELD_NUMBER 
 
Field Value
Type
Description
int

ATTACHED_GIFS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ATTACHED_GIFS_FIELD_NUMBER 
 
Field Value
Type
Description
int

ATTACHMENT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ATTACHMENT_FIELD_NUMBER 
 
Field Value
Type
Description
int

CARDS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CARDS_FIELD_NUMBER 
 
Field Value
Type
Description
int

CARDS_V2_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CARDS_V2_FIELD_NUMBER 
 
Field Value
Type
Description
int

CLIENT_ASSIGNED_MESSAGE_ID_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CLIENT_ASSIGNED_MESSAGE_ID_FIELD_NUMBER 
 
Field Value
Type
Description
int

CREATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CREATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

DELETE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DELETE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int
  public 
  
 static 
  
 final 
  
 int 
  
 DELETION_METADATA_FIELD_NUMBER 
 
Field Value
Type
Description
int

EMOJI_REACTION_SUMMARIES_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 EMOJI_REACTION_SUMMARIES_FIELD_NUMBER 
 
Field Value
Type
Description
int

FALLBACK_TEXT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 FALLBACK_TEXT_FIELD_NUMBER 
 
Field Value
Type
Description
int

FORMATTED_TEXT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 FORMATTED_TEXT_FIELD_NUMBER 
 
Field Value
Type
Description
int

LAST_UPDATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LAST_UPDATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

MATCHED_URL_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 MATCHED_URL_FIELD_NUMBER 
 
Field Value
Type
Description
int

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

PRIVATE_MESSAGE_VIEWER_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PRIVATE_MESSAGE_VIEWER_FIELD_NUMBER 
 
Field Value
Type
Description
int
  public 
  
 static 
  
 final 
  
 int 
  
 QUOTED_MESSAGE_METADATA_FIELD_NUMBER 
 
Field Value
Type
Description
int

SENDER_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SENDER_FIELD_NUMBER 
 
Field Value
Type
Description
int

SLASH_COMMAND_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SLASH_COMMAND_FIELD_NUMBER 
 
Field Value
Type
Description
int

SPACE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 SPACE_FIELD_NUMBER 
 
Field Value
Type
Description
int

TEXT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TEXT_FIELD_NUMBER 
 
Field Value
Type
Description
int

THREAD_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 THREAD_FIELD_NUMBER 
 
Field Value
Type
Description
int

THREAD_REPLY_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 THREAD_REPLY_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 Message 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description

getDescriptor()

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

newBuilder()

  public 
  
 static 
  
 Message 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(Message prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAccessoryWidgets(int index)

  public 
  
 AccessoryWidget 
  
 getAccessoryWidgets 
 ( 
 int 
  
 index 
 ) 
 

Optional. 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. For details, see Add interactive widgets at the bottom of a message .

Creating a message with accessory widgets requires app authentication .

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAccessoryWidgetsCount()

  public 
  
 int 
  
 getAccessoryWidgetsCount 
 () 
 

Optional. 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. For details, see Add interactive widgets at the bottom of a message .

Creating a message with accessory widgets requires app authentication .

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getAccessoryWidgetsList()

  public 
  
 List<AccessoryWidget> 
  
 getAccessoryWidgetsList 
 () 
 

Optional. 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. For details, see Add interactive widgets at the bottom of a message .

Creating a message with accessory widgets requires app authentication .

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getAccessoryWidgetsOrBuilder(int index)

  public 
  
 AccessoryWidgetOrBuilder 
  
 getAccessoryWidgetsOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Optional. 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. For details, see Add interactive widgets at the bottom of a message .

Creating a message with accessory widgets requires app authentication .

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAccessoryWidgetsOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 AccessoryWidgetOrBuilder 
>  
 getAccessoryWidgetsOrBuilderList 
 () 
 

Optional. 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. For details, see Add interactive widgets at the bottom of a message .

Creating a message with accessory widgets requires app authentication .

repeated .google.chat.v1.AccessoryWidget accessory_widgets = 44 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
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
Type
Description

The actionResponse.

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
Type
Description

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
Name
Description
index
int
Returns
Type
Description

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
Type
Description
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
Type
Description

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
Name
Description
index
int
Returns
Type
Description

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
Type
Description
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
Type
Description

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
Type
Description

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
Name
Description
index
int
Returns
Type
Description

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
Type
Description
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
Type
Description

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
Name
Description
index
int
Returns
Type
Description

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
Type
Description
List < ? extends com.google.chat.v1.AttachedGifOrBuilder >

getAttachment(int index)

  public 
  
 Attachment 
  
 getAttachment 
 ( 
 int 
  
 index 
 ) 
 

Optional. User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAttachmentCount()

  public 
  
 int 
  
 getAttachmentCount 
 () 
 

Optional. User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getAttachmentList()

  public 
  
 List<Attachment> 
  
 getAttachmentList 
 () 
 

Optional. User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getAttachmentOrBuilder(int index)

  public 
  
 AttachmentOrBuilder 
  
 getAttachmentOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Optional. User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getAttachmentOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 AttachmentOrBuilder 
>  
 getAttachmentOrBuilderList 
 () 
 

Optional. User-uploaded attachment.

repeated .google.chat.v1.Attachment attachment = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
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
Name
Description
index
int
Returns
Type
Description

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
Type
Description
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
Type
Description
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
Name
Description
index
int
Returns
Type
Description

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
Type
Description
List < ? extends com.google.chat.v1.ContextualAddOnMarkup.CardOrBuilder >

getCardsV2(int index)

  public 
  
 CardWithId 
  
 getCardsV2 
 ( 
 int 
  
 index 
 ) 
 

Optional. 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 how to create a message that contains cards, see Send a message .

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getCardsV2Count()

  public 
  
 int 
  
 getCardsV2Count 
 () 
 

Optional. 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 how to create a message that contains cards, see Send a message .

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getCardsV2List()

  public 
  
 List<CardWithId> 
  
 getCardsV2List 
 () 
 

Optional. 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 how to create a message that contains cards, see Send a message .

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getCardsV2OrBuilder(int index)

  public 
  
 CardWithIdOrBuilder 
  
 getCardsV2OrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Optional. 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 how to create a message that contains cards, see Send a message .

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getCardsV2OrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 CardWithIdOrBuilder 
>  
 getCardsV2OrBuilderList 
 () 
 

Optional. 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 how to create a message that contains cards, see Send a message .

Card builder

repeated .google.chat.v1.CardWithId cards_v2 = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

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
Type
Description

The createTime.

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
Type
Description

getDefaultInstanceForType()

  public 
  
 Message 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type
Description

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
Type
Description

The deleteTime.

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
Type
Description
  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
Type
Description

The deletionMetadata.

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
Type
Description

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
Name
Description
index
int
Returns
Type
Description

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
Type
Description
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
Type
Description

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
Name
Description
index
int
Returns
Type
Description

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
Type
Description
List < ? extends com.google.chat.v1.EmojiReactionSummaryOrBuilder >

getFallbackText()

  public 
  
 String 
  
 getFallbackText 
 () 
 

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The fallbackText.

getFallbackTextBytes()

  public 
  
 ByteString 
  
 getFallbackTextBytes 
 () 
 

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

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, monospace block, and bulleted list.

  • 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
Type
Description

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, monospace block, and bulleted list.

  • 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
Type
Description

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
Type
Description

The lastUpdateTime.

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
Type
Description

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
Type
Description

The matchedUrl.

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
Type
Description

getName()

  public 
  
 String 
  
 getName 
 () 
 

Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type
Description

The name.

getNameBytes()

  public 
  
 ByteString 
  
 getNameBytes 
 () 
 

Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type
Description

The bytes for name.

getParserForType()

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

getPrivateMessageViewer()

  public 
  
 User 
  
 getPrivateMessageViewer 
 () 
 

Optional. 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. To include this field in your request, you must call the Chat API using app authentication and omit the following:

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

Returns
Type
Description

The privateMessageViewer.

getPrivateMessageViewerOrBuilder()

  public 
  
 UserOrBuilder 
  
 getPrivateMessageViewerOrBuilder 
 () 
 

Optional. 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. To include this field in your request, you must call the Chat API using app authentication and omit the following:

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

Returns
Type
Description
  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
Type
Description

The quotedMessageMetadata.

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
Type
Description

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
Type
Description

The sender.

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
Type
Description

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

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
Type
Description

The slashCommand.

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
Type
Description

getSpace()

  public 
  
 Space 
  
 getSpace 
 () 
 

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

.google.chat.v1.Space space = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

The space.

getSpaceOrBuilder()

  public 
  
 SpaceOrBuilder 
  
 getSpaceOrBuilder 
 () 
 

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

.google.chat.v1.Space space = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

getText()

  public 
  
 String 
  
 getText 
 () 
 

Optional. 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 message .

string text = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The text.

getTextBytes()

  public 
  
 ByteString 
  
 getTextBytes 
 () 
 

Optional. 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 message .

string text = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

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
Type
Description

The thread.

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
Type
Description

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
Type
Description

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
Type
Description

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
Type
Description

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
Type
Description

Whether the deleteTime field is set.

  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
Type
Description

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
Type
Description

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
Type
Description

Whether the matchedUrl field is set.

hasPrivateMessageViewer()

  public 
  
 boolean 
  
 hasPrivateMessageViewer 
 () 
 

Optional. 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. To include this field in your request, you must call the Chat API using app authentication and omit the following:

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

Returns
Type
Description

Whether the privateMessageViewer field is set.

  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
Type
Description

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
Type
Description

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
Type
Description

Whether the slashCommand field is set.

hasSpace()

  public 
  
 boolean 
  
 hasSpace 
 () 
 

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

.google.chat.v1.Space space = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

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
Type
Description

Whether the thread field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 Message 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

  public 
  
 Message 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: