SocialGraphApiProtoPartialNameOptionsNamePartSpec

Posted on by Darth Emmett

GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoPartialNameOptionsNamePartSpec

Table of Contents ▼

Jump to a specific part of the page:

Description

Specifies how each piece of the name should be handled. Names are structured into given name and family name and this allows an independent specification for each of these pieces. Very limited preprocessing is done for this option (leading whitespace trimming mostly). Composed names are treated as a single unit and are not broken down.

Attributes List

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

View Attributes

Attributes

  1. hideAll (type: boolean(), default: nil)
    - Completely omit that part of the name.
  2. showAll (type: boolean(), default: nil)
    - Show the complete name. Note that this does not express the same semantics as show_first_n_chars=length_of_name, because when regenerating a shortened name the new name could have more characters, thus yielding a different result.
  3. showFirstNChars (type: integer(), default: nil)
    - Show first n characters. Same note about characters referring to "grapheme_clusters" applies.
  4. showInitial (type: boolean(), default: nil)
    - Show only the initial, i.e., a single character. Note that "character" refers to "user-perceived" characters, aka a "grapheme cluster". See go/morphology for more details.
  5. truncationIndicator (type: String.t, default: nil)
    - Which truncation indicator to use after the shortened piece of the name. Will be ignored for the hide_all or show_all options.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoPartialNameOptionsNamePartSpec{
hideAll: boolean() | nil,
showAll: boolean() | nil,
showFirstNChars: integer() | nil,
showInitial: boolean() | nil,
truncationIndicator: String.t() | nil
}

Function

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

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