Show / Hide Table of Contents

Class Message

Message posted to a Space.

Inheritance
object
Message
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudSearch.v1.Data
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class Message : IDirectResponseSchema

Properties

Annotations

Annotations parsed and extracted from the text body.

Declaration
[JsonProperty("annotations")]
public virtual IList<Annotation> Annotations { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><Annotation>

AppProfile

Custom display profile info for apps. Leave the field empty for real users.

Declaration
[JsonProperty("appProfile")]
public virtual AppsDynamiteSharedAppProfile AppProfile { get; set; }
Property Value
Type Description
AppsDynamiteSharedAppProfile

Attachments

Attachments parsed from incoming webhooks

Declaration
[JsonProperty("attachments")]
public virtual IList<Attachment> Attachments { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><Attachment>

Attributes

Lightweight message attributes which values are calculated and set in the servers.

Declaration
[JsonProperty("attributes")]
public virtual MessageAttributes Attributes { get; set; }
Property Value
Type Description
MessageAttributes

BotResponses

Responses from bots indicating if extra auth/config is needed.

Declaration
[JsonProperty("botResponses")]
public virtual IList<BotResponse> BotResponses { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><BotResponse>

CommunalLabels

Communal labels associated with a message. These exist on the message itself regardless of which user fetches them. Order of entries is arbitrary and will not list duplicates of the same label_id. See go/chat-labels-design for details.

Declaration
[JsonProperty("communalLabels")]
public virtual IList<CommunalLabelTag> CommunalLabels { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><CommunalLabelTag>

ContentReportSummary

Declaration
[JsonProperty("contentReportSummary")]
public virtual ContentReportSummary ContentReportSummary { get; set; }
Property Value
Type Description
ContentReportSummary

CreateTime

Time when the Message was posted in microseconds.

Declaration
[JsonProperty("createTime")]
public virtual long? CreateTime { get; set; }
Property Value
Type Description
long?

CreatorId

ID of the User who posted the Message. This includes information to identify if this was posted by an App on behalf of a user.

Declaration
[JsonProperty("creatorId")]
public virtual UserId CreatorId { get; set; }
Property Value
Type Description
UserId

DeletableBy

Indicates who can delete the message. This field is set on the read path (e.g. ListTopics) but doesn’t have any effect on the write path (e.g. CreateMessageRequest).

Declaration
[JsonProperty("deletableBy")]
public virtual string DeletableBy { get; set; }
Property Value
Type Description
string

DeletedByVault

Was this message deleted by Vault (Only used for Vault support) This is false if message is live or message was deleted by user.

Declaration
[JsonProperty("deletedByVault")]
public virtual bool? DeletedByVault { get; set; }
Property Value
Type Description
bool?

DeleteTime

Time when the Message was deleted in microseconds. This field is set to nonzero value only for Messages deleted globally.

Declaration
[JsonProperty("deleteTime")]
public virtual long? DeleteTime { get; set; }
Property Value
Type Description
long?

DeleteTimeForRequester

Time when the Message was per-user deleted by the message requester in microseconds. This field is set to nonzero value only for Message per-user deleted by the requester.

Declaration
[JsonProperty("deleteTimeForRequester")]
public virtual long? DeleteTimeForRequester { get; set; }
Property Value
Type Description
long?

DlpScanOutcome

Data Loss Prevention scan information for this message. Messages are evaluated in the backend on create message/topic and edit message actions. DEPRECATED: use dlp_scan_summary instead.

Declaration
[JsonProperty("dlpScanOutcome")]
public virtual string DlpScanOutcome { get; set; }
Property Value
Type Description
string

DlpScanSummary

Data Loss Prevention scan information for this message. Messages are evaluated in the backend on create message/topic and edit message actions.

Declaration
[JsonProperty("dlpScanSummary")]
public virtual DlpScanSummary DlpScanSummary { get; set; }
Property Value
Type Description
DlpScanSummary

EditableBy

Indicates who can edit the message. This field is set on the read path (e.g. ListTopics) but doesn’t have any effect on the write path (e.g. CreateMessageRequest).

Declaration
[JsonProperty("editableBy")]
public virtual string EditableBy { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FallbackText

A plain-text description of the attachment, used when clients cannot display formatted attachment (e.g. mobile push notifications).

Declaration
[JsonProperty("fallbackText")]
public virtual string FallbackText { get; set; }
Property Value
Type Description
string

Id

ID of the resource.

Declaration
[JsonProperty("id")]
public virtual MessageId Id { get; set; }
Property Value
Type Description
MessageId

IsContentPurged

Whether the message is content purged. Content purged messages contain only data required for tombstone (see go/chat-infinite-tombstone). This field is only used by Vault to display tombstone and should only be set to true if the message is a tombstone.

Declaration
[JsonProperty("isContentPurged")]
public virtual bool? IsContentPurged { get; set; }
Property Value
Type Description
bool?

IsInlineReply

Output only. Indicates if the message is an inline reply. Set to true only if the message's ParentPath is non-NULL. Currently, only inline replies have non-NULL ParentPath. See go/chat-be-inline-reply-indicator.

Declaration
[JsonProperty("isInlineReply")]
public virtual bool? IsInlineReply { get; set; }
Property Value
Type Description
bool?

LastEditTime

If the message was edited by a user, timestamp of the last edit, in microseconds.

Declaration
[JsonProperty("lastEditTime")]
public virtual long? LastEditTime { get; set; }
Property Value
Type Description
long?

LastUpdateTime

Time when the Message text was last updated in microseconds.

Declaration
[JsonProperty("lastUpdateTime")]
public virtual long? LastUpdateTime { get; set; }
Property Value
Type Description
long?

LocalId

A unique id specified on the client side.

Declaration
[JsonProperty("localId")]
public virtual string LocalId { get; set; }
Property Value
Type Description
string

MessageIntegrationPayload

An optional payload (restricted to 1P applications) that will be stored with this message. This can only be set by the 1P API and should be used to deliver additional data such a 1P sync version, 1P entity ID to the client for more advanced functionality [Eg. inform Group Tasks tab of new version while linking, fetch &amp; render a live Task/Meet call tile].

Declaration
[JsonProperty("messageIntegrationPayload")]
public virtual AppsDynamiteSharedMessageIntegrationPayload MessageIntegrationPayload { get; set; }
Property Value
Type Description
AppsDynamiteSharedMessageIntegrationPayload

MessageOrigin

Where the message was posted from

Declaration
[JsonProperty("messageOrigin")]
public virtual string MessageOrigin { get; set; }
Property Value
Type Description
string

MessageState

State of the message, indicating whether the message is visible to all members in the group or is only visible to the sender only, or the private_message_viewer if it is set.

Declaration
[JsonProperty("messageState")]
public virtual string MessageState { get; set; }
Property Value
Type Description
string

OriginAppSuggestions

Indicates if this message contains any suggestions that were provided by any Apps.

Declaration
[JsonProperty("originAppSuggestions")]
public virtual IList<AppsDynamiteSharedOriginAppSuggestion> OriginAppSuggestions { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><AppsDynamiteSharedOriginAppSuggestion>

PersonalLabels

Personal labels associated with a message for the viewing user. Order of entries is arbitrary and will not list duplicates of the same label_id. See go/chat-labels-design for details. NOTE: This will be unpopulated in the case of SpaceChangelog events.

Declaration
[JsonProperty("personalLabels")]
public virtual IList<PersonalLabelTag> PersonalLabels { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><PersonalLabelTag>

PrivateMessageInfos

A list of per-user private information. This is deprecated, because we no longer plan to support partially private messages or private messages for multiple users. The message_state and private_message_viewer fields should be sufficient for this infrastructure.

Declaration
[JsonProperty("privateMessageInfos")]
public virtual IList<PrivateMessageInfo> PrivateMessageInfos { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><PrivateMessageInfo>

PrivateMessageViewer

Should only be set if the Message State is PRIVATE. If set, the message content is only visible to this user (and any apps associated with the message), as well as the message creator. If unset, a private message is visible to the message creator only.

Declaration
[JsonProperty("privateMessageViewer")]
public virtual UserId PrivateMessageViewer { get; set; }
Property Value
Type Description
UserId

Props

Contains additional (currently Hangouts Classic only) properties applicable to this message.

Declaration
[JsonProperty("props")]
public virtual MessageProps Props { get; set; }
Property Value
Type Description
MessageProps

QuotedByState

Output only. Whether this message has been quoted by another message or not. Used by clients to handle message edit flows for messages that have been quoted.

Declaration
[JsonProperty("quotedByState")]
public virtual string QuotedByState { get; set; }
Property Value
Type Description
string

QuotedMessageMetadata

Output only. Metadata for a message that is quoted by this message.

Declaration
[JsonProperty("quotedMessageMetadata")]
public virtual QuotedMessageMetadata QuotedMessageMetadata { get; set; }
Property Value
Type Description
QuotedMessageMetadata

Reactions

A list of user reactions to this message. Ordered by the timestamp of the first reaction, ascending (oldest to newest).

Declaration
[JsonProperty("reactions")]
public virtual IList<AppsDynamiteSharedReaction> Reactions { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><AppsDynamiteSharedReaction>

Reports

Output only. Details of content reports. Set only when the request asks for it.

Declaration
[JsonProperty("reports")]
public virtual IList<ContentReport> Reports { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><ContentReport>

RetentionSettings

The retention settings of the message.

Declaration
[JsonProperty("retentionSettings")]
public virtual AppsDynamiteSharedRetentionSettings RetentionSettings { get; set; }
Property Value
Type Description
AppsDynamiteSharedRetentionSettings

RichTextFormattingType

Used by clients to correctly log format type for message creation due to complexity with client side optimistic update (see go/content-metric-post-send-logging for details). Currently, only set by server in the message or topic creation path.

Declaration
[JsonProperty("richTextFormattingType")]
public virtual string RichTextFormattingType { get; set; }
Property Value
Type Description
string

SecondaryMessageKey

A client-specified string that can be used to uniquely identify a message in a space, in lieu of id.message_id.

Declaration
[JsonProperty("secondaryMessageKey")]
public virtual string SecondaryMessageKey { get; set; }
Property Value
Type Description
string

TextBody

Plaintext body of the Message.

Declaration
[JsonProperty("textBody")]
public virtual string TextBody { get; set; }
Property Value
Type Description
string

TombstoneMetadata

Information for the stoning of a Message.

Declaration
[JsonProperty("tombstoneMetadata")]
public virtual TombstoneMetadata TombstoneMetadata { get; set; }
Property Value
Type Description
TombstoneMetadata

UpdaterId

ID of the User who last updated (created/edited/deleted) the Message. This includes information to identify if this was updated by an App on behalf of a user.

Declaration
[JsonProperty("updaterId")]
public virtual UserId UpdaterId { get; set; }
Property Value
Type Description
UserId

UploadMetadata

UploadMetadata b/36864213 is an ongoing effort to move UploadMetadata out of annotations field and save it to upload_metadata field only. After the migration, UploadMetadata will only be saved in this field.

Declaration
[JsonProperty("uploadMetadata")]
public virtual IList<UploadMetadata> UploadMetadata { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<T><UploadMetadata>

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX