class AsposeEmailCloud::MapiContactNamePropertySetDto

The properties are used to specify the name of the person represented by the contact

Attributes

display_name[RW]

Full name of the contact

@return [String]

display_name_prefix[RW]

Title of the contact

@return [String]

file_under[RW]

Name under which to file this contact when displaying a list of contacts

@return [String]

file_under_id[RW]

Value specifying how to generate and recompute the property when other properties are changed

@return [Integer]

generation[RW]

Generation suffix of the contact

@return [String]

given_name[RW]

Given name (first name) of the contact

@return [String]

initials[RW]

Initials of the contact

@return [String]

middle_name[RW]

Middle name of the contact

@return [String]

nickname[RW]

Nickname of the contact

@return [String]

surname[RW]

Surname (family name) of the contact

@return [String]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 62
def self.attribute_map
  {
    :'display_name' => :'displayName',
    :'display_name_prefix' => :'displayNamePrefix',
    :'file_under' => :'fileUnder',
    :'file_under_id' => :'fileUnderId',
    :'generation' => :'generation',
    :'given_name' => :'givenName',
    :'initials' => :'initials',
    :'middle_name' => :'middleName',
    :'nickname' => :'nickname',
    :'surname' => :'surname'
  }
end
new( display_name: nil, display_name_prefix: nil, file_under: nil, file_under_id: nil, generation: nil, given_name: nil, initials: nil, middle_name: nil, nickname: nil, surname: nil) click to toggle source

Initializes the object @param [String] display_name Full name of the contact

@param [String] display_name_prefix Title of the contact

@param [String] file_under Name under which to file this contact when displaying a list of contacts

@param [Integer] file_under_id Value specifying how to generate and recompute the property when other properties are changed

@param [String] generation Generation suffix of the contact

@param [String] given_name Given name (first name) of the contact

@param [String] initials Initials of the contact

@param [String] middle_name Middle name of the contact

@param [String] nickname Nickname of the contact

@param [String] surname Surname (family name) of the contact

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 104
def initialize(
  display_name: nil,
  display_name_prefix: nil,
  file_under: nil,
  file_under_id: nil,
  generation: nil,
  given_name: nil,
  initials: nil,
  middle_name: nil,
  nickname: nil,
  surname: nil)
  self.display_name = display_name if display_name
  self.display_name_prefix = display_name_prefix if display_name_prefix
  self.file_under = file_under if file_under
  self.file_under_id = file_under_id if file_under_id
  self.generation = generation if generation
  self.given_name = given_name if given_name
  self.initials = initials if initials
  self.middle_name = middle_name if middle_name
  self.nickname = nickname if nickname
  self.surname = surname if surname
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 78
def self.swagger_types
  {
    :'display_name' => :'String',
    :'display_name_prefix' => :'String',
    :'file_under' => :'String',
    :'file_under_id' => :'Integer',
    :'generation' => :'String',
    :'given_name' => :'String',
    :'initials' => :'String',
    :'middle_name' => :'String',
    :'nickname' => :'String',
    :'surname' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 147
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display_name == o.display_name &&
      display_name_prefix == o.display_name_prefix &&
      file_under == o.file_under &&
      file_under_id == o.file_under_id &&
      generation == o.generation &&
      given_name == o.given_name &&
      initials == o.initials &&
      middle_name == o.middle_name &&
      nickname == o.nickname &&
      surname == o.surname
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 200
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 270
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 177
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 164
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 170
def hash
  [display_name, display_name_prefix, file_under, file_under_id, generation, given_name, initials, middle_name, nickname, surname].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 129
def list_invalid_properties
  invalid_properties = Array.new
  if @file_under_id.nil?
    invalid_properties.push('invalid value for "file_under_id", file_under_id cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 250
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 256
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 244
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb, line 140
def valid?
  return false if @file_under_id.nil?
  true
end