Show / Hide Table of Contents

Class Segment

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

Properties

ETag

The ETag of the item.

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

Formatting

Formatting to be applied when rendering the Segment. For all segment types, this is the standard way of representing that the Segment should be rendered in bold, italics, etc.

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

HashtagData

For HASHTAG type:

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

LinkData

Type-specific metadata. At most one of these should be populated, and the one that is populated should correspond to the type of the Segment. For LINK type:

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

Text

Text content of the Segment. As a general rule, this field should contain the actual text that should be rendered in the UI. Thus, for a hashtag, it should be "#Foo", and for a link, it should be the display text. Clients that do not understand a particular segment type may use this text, along with the Formatting info below, as a fallback for display. The field is not required -- if all relevant information is carried in other metadata fields and there is no need for a fallback, or it is not practical for a fallback to be provided for any other reason, the field may be left blank. A standard example would be a user reference being transmitted between server layers, where a gaia-ID representation may be sufficient and there is no need for a textual fallback. In such a case, it would be valid and useful - though not required - for servers to compute and populate a fallback on the serving path.

Declaration
[JsonProperty("text")]
public virtual string Text { get; set; }
Property Value
Type Description
System.String

Type

Type of Segment.

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

UserMentionData

For USER_MENTION type:

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

Implements

Google.Apis.Requests.IDirectResponseSchema
In This Article
Back to top