Class: Google::Apis::PlusV1::Person::Name

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/plus_v1/classes.rb,
generated/google/apis/plus_v1/representations.rb,
generated/google/apis/plus_v1/representations.rb

Overview

An object representation of the individual components of a person's name.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Name

Returns a new instance of Name.


1816
1817
1818
# File 'generated/google/apis/plus_v1/classes.rb', line 1816

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#family_nameString

The family name (last name) of this person. Corresponds to the JSON property familyName

Returns:

  • (String)

1789
1790
1791
# File 'generated/google/apis/plus_v1/classes.rb', line 1789

def family_name
  @family_name
end

#formattedString

The full name of this person, including middle names, suffixes, etc. Corresponds to the JSON property formatted

Returns:

  • (String)

1794
1795
1796
# File 'generated/google/apis/plus_v1/classes.rb', line 1794

def formatted
  @formatted
end

#given_nameString

The given name (first name) of this person. Corresponds to the JSON property givenName

Returns:

  • (String)

1799
1800
1801
# File 'generated/google/apis/plus_v1/classes.rb', line 1799

def given_name
  @given_name
end

#honorific_prefixString

The honorific prefixes (such as "Dr." or "Mrs.") for this person. Corresponds to the JSON property honorificPrefix

Returns:

  • (String)

1804
1805
1806
# File 'generated/google/apis/plus_v1/classes.rb', line 1804

def honorific_prefix
  @honorific_prefix
end

#honorific_suffixString

The honorific suffixes (such as "Jr.") for this person. Corresponds to the JSON property honorificSuffix

Returns:

  • (String)

1809
1810
1811
# File 'generated/google/apis/plus_v1/classes.rb', line 1809

def honorific_suffix
  @honorific_suffix
end

#middle_nameString

The middle name of this person. Corresponds to the JSON property middleName

Returns:

  • (String)

1814
1815
1816
# File 'generated/google/apis/plus_v1/classes.rb', line 1814

def middle_name
  @middle_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1821
1822
1823
1824
1825
1826
1827
1828
# File 'generated/google/apis/plus_v1/classes.rb', line 1821

def update!(**args)
  @family_name = args[:family_name] if args.key?(:family_name)
  @formatted = args[:formatted] if args.key?(:formatted)
  @given_name = args[:given_name] if args.key?(:given_name)
  @honorific_prefix = args[:honorific_prefix] if args.key?(:honorific_prefix)
  @honorific_suffix = args[:honorific_suffix] if args.key?(:honorific_suffix)
  @middle_name = args[:middle_name] if args.key?(:middle_name)
end