View Source GoogleApi.ContentWarehouse.V1.Model.SocialCommonSegment (google_api_content_warehouse v0.3.0)

Attributes

  • formatting (type: GoogleApi.ContentWarehouse.V1.Model.SocialCommonFormatting.t, default: nil) - 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.
  • hashtagData (type: GoogleApi.ContentWarehouse.V1.Model.SocialCommonHashtagData.t, default: nil) - For HASHTAG type:
  • linkData (type: GoogleApi.ContentWarehouse.V1.Model.SocialCommonLinkData.t, default: nil) - 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:
  • searchLinkData (type: GoogleApi.ContentWarehouse.V1.Model.SocialCommonSearchLinkData.t, default: nil) - For SEARCH_LINK type:
  • text (type: String.t, default: nil) - 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.
  • type (type: String.t, default: nil) - Type of Segment.
  • userMentionData (type: GoogleApi.ContentWarehouse.V1.Model.SocialCommonUserMentionData.t, default: nil) - For USER_MENTION type:

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.