SocialCommonSegment

Posted on by Darth Autocrat

GoogleApi.ContentWarehouse.V1.Model.SocialCommonSegment

Table of Contents ▼

Jump to a specific part of the page:

Description

No description given.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

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

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.SocialCommonSegment{
formatting: GoogleApi.ContentWarehouse.V1.Model.SocialCommonFormatting.t() | nil,
hashtagData: GoogleApi.ContentWarehouse.V1.Model.SocialCommonHashtagData.t() | nil,
linkData: GoogleApi.ContentWarehouse.V1.Model.SocialCommonLinkData.t() | nil,
searchLinkData: GoogleApi.ContentWarehouse.V1.Model.SocialCommonSearchLinkData.t() | nil,
text: String.t() | nil,
type: String.t() | nil,
userMentionData: GoogleApi.ContentWarehouse.V1.Model.SocialCommonUserMentionData.t() | nil
}

Function

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

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.SocialCommonSegment