google_api_people v0.4.1 GoogleApi.People.V1.Model.Name View Source

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

Attributes

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

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

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

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.