Show / Hide Table of Contents

Class Annotation

NOTE WHEN ADDING NEW PROTO FIELDS: Be sure to add datapol annotations to new fields with potential PII, so they get scrubbed when logging protos for errors. NEXT TAG: 31

Inheritance
object
Annotation
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 Annotation : IDirectResponseSchema

Properties

BabelPlaceholderMetadata

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

CardCapabilityMetadata

LINT.ThenChange(//depot/google3/java/com/google/apps/dynamite/v1/backend/action/common/SystemMessageHelper.java)

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

ChipRenderType

Whether the annotation should be rendered as a preview chip. If this is missing or unspecified, fallback to should_not_render on the metadata.

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

ConsentedAppUnfurlMetadata

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

CustomEmojiMetadata

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

DataLossPreventionMetadata

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

DriveMetadata

Chip annotations

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

ETag

The ETag of the item.

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

FormatMetadata

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

GroupRetentionSettingsUpdated

Declaration
[JsonProperty("groupRetentionSettingsUpdated")]
public virtual GroupRetentionSettingsUpdatedMetaData GroupRetentionSettingsUpdated { get; set; }
Property Value
Type Description
GroupRetentionSettingsUpdatedMetaData

GsuiteIntegrationMetadata

Metadata for 1P integrations like tasks, calendar. These are supported only through integration server as 1P integrations use the integration API (which in turn uses backend API with special permissions) to post messages. Clients should never set this. LINT.IfChange

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

IncomingWebhookChangedMetadata

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

InlineRenderFormat

The inline render format of this annotation. go/drive-smart-chips-chat-v2.

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

IntegrationConfigUpdated

LINT.ThenChange(//depot/google3/java/com/google/apps/dynamite/v1/backend/action/common/SystemMessageHelper.java)

Declaration
[JsonProperty("integrationConfigUpdated")]
public virtual IntegrationConfigUpdatedMetadata IntegrationConfigUpdated { get; set; }
Property Value
Type Description
IntegrationConfigUpdatedMetadata

InteractionData

Additional interaction data for this annotation.

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

Length

Length of the text_body substring beginning from start_index the Annotation corresponds to.

Declaration
[JsonProperty("length")]
public virtual int? Length { get; set; }
Property Value
Type Description
int?

LocalId

  • A client-assigned ID for this annotation. This is helpful in matching the back-filled annotations to the original annotations on client side, without having to re-parse the message. There is no guarantee an annotation has a local_id, it's a purely client used and controlled field with no guarantee of uniqueness.
Declaration
[JsonProperty("localId")]
public virtual string LocalId { get; set; }
Property Value
Type Description
string

MembershipChanged

Metadata for system messages. Clients should never set this. LINT.IfChange

Declaration
[JsonProperty("membershipChanged")]
public virtual MembershipChangedMetadata MembershipChanged { get; set; }
Property Value
Type Description
MembershipChangedMetadata

ReadReceiptsSettingsMetadata

Declaration
[JsonProperty("readReceiptsSettingsMetadata")]
public virtual ReadReceiptsSettingsUpdatedMetadata ReadReceiptsSettingsMetadata { get; set; }
Property Value
Type Description
ReadReceiptsSettingsUpdatedMetadata

RequiredMessageFeaturesMetadata

Metadata that defines all of the required features that must be rendered in the message. Clients can use this to see whether they support the entire message, or show a fallback chip otherwise. See go/message-quoting-client-to-server for details. LINT.ThenChange( //depot/google3/java/com/google/apps/dynamite/v1/allshared/parser/AnnotationSanitizer.java, //depot/google3/java/com/google/apps/dynamite/v1/backend/action/common/SystemMessageHelper.java, //depot/google3/java/com/google/caribou/eli/mediation/chat/AnnotationConverter.java )

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

RoomUpdated

Declaration
[JsonProperty("roomUpdated")]
public virtual RoomUpdatedMetadata RoomUpdated { get; set; }
Property Value
Type Description
RoomUpdatedMetadata

ServerInvalidated

Whether or not the annotation is invalidated by the server. Example of situations for invalidation include: when the URL is malformed, or when Drive item ID is rejected by Drive Service.

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

SlashCommandMetadata

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

StartIndex

Start index (0-indexed) of the Message text the Annotation corresponds to, inclusive.

Declaration
[JsonProperty("startIndex")]
public virtual int? StartIndex { get; set; }
Property Value
Type Description
int?

Type

Type of the Annotation.

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

UniqueId

  • A unique server-assigned ID for this annotation. This is helpful in matching annotation objects when fetched from service. All uploads should have a unique_id after the message they are attached to is successfully sent. Url annotations that originally were uploads (i.e. policy violations) will have a unique_id after the message they are attached to is successfully sent. No other url annotations should have a unique_id. All drive annotations should have a unique_id after the message they are attached to is successfully sent.
Declaration
[JsonProperty("uniqueId")]
public virtual string UniqueId { get; set; }
Property Value
Type Description
string

UploadMetadata

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

UrlMetadata

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

UserMentionMetadata

Metadata that clients can set for annotations. LINT.IfChange In-text annotations

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

VideoCallMetadata

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

YoutubeMetadata

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

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX