GoogleApi.People.V1.Model.Name (google_api_people v0.37.6) View Source

A person's name. If the name is a mononym, the family name is empty.

Attributes

  • displayName (type: String.t, default: nil) - Output only. The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
  • displayNameLastFirst (type: String.t, default: nil) - Output only. The display name with the last name first formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
  • familyName (type: String.t, default: nil) - The family name.
  • givenName (type: String.t, default: nil) - The given name.
  • honorificPrefix (type: String.t, default: nil) - The honorific prefixes, such as Mrs. or Dr.
  • honorificSuffix (type: String.t, default: nil) - The honorific suffixes, such as Jr.
  • metadata (type: GoogleApi.People.V1.Model.FieldMetadata.t, default: nil) - Metadata about the name.
  • middleName (type: String.t, default: nil) - The middle name(s).
  • phoneticFamilyName (type: String.t, default: nil) - The family name spelled as it sounds.
  • phoneticFullName (type: String.t, default: nil) - The full name spelled as it sounds.
  • phoneticGivenName (type: String.t, default: nil) - The given name spelled as it sounds.
  • phoneticHonorificPrefix (type: String.t, default: nil) - The honorific prefixes spelled as they sound.
  • phoneticHonorificSuffix (type: String.t, default: nil) - The honorific suffixes spelled as they sound.
  • phoneticMiddleName (type: String.t, default: nil) - The middle name(s) spelled as they sound.
  • unstructuredName (type: String.t, default: nil) - The free form name value.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.People.V1.Model.Name{
  displayName: String.t() | nil,
  displayNameLastFirst: String.t() | nil,
  familyName: String.t() | nil,
  givenName: String.t() | nil,
  honorificPrefix: String.t() | nil,
  honorificSuffix: String.t() | nil,
  metadata: GoogleApi.People.V1.Model.FieldMetadata.t() | nil,
  middleName: String.t() | nil,
  phoneticFamilyName: String.t() | nil,
  phoneticFullName: String.t() | nil,
  phoneticGivenName: String.t() | nil,
  phoneticHonorificPrefix: String.t() | nil,
  phoneticHonorificSuffix: String.t() | nil,
  phoneticMiddleName: String.t() | nil,
  unstructuredName: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.