Class: AsposeEmailCloud::MapiContactNamePropertySetDto

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#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) ⇒ MapiContactNamePropertySetDto

Initializes the object

Parameters:

  • display_name (String) (defaults to: nil) —

    Full name of the contact

  • display_name_prefix (String) (defaults to: nil) —

    Title of the contact

  • file_under (String) (defaults to: nil) —

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

  • file_under_id (Integer) (defaults to: nil) —

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

  • generation (String) (defaults to: nil) —

    Generation suffix of the contact

  • given_name (String) (defaults to: nil) —

    Given name (first name) of the contact

  • initials (String) (defaults to: nil) —

    Initials of the contact

  • middle_name (String) (defaults to: nil) —

    Middle name of the contact

  • nickname (String) (defaults to: nil) —

    Nickname of the contact

  • surname (String) (defaults to: nil) —

    Surname (family name) of the contact



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# 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

Instance Attribute Details

#display_name ⇒ String

Full name of the contact

Returns:

  • (String) 


33
34
35
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 33

def display_name
  @display_name
end

#display_name_prefix ⇒ String

Title of the contact

Returns:

  • (String) 


36
37
38
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 36

def display_name_prefix
  @display_name_prefix
end

#file_under ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 39

def file_under
  @file_under
end

#file_under_id ⇒ Integer

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

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 42

def file_under_id
  @file_under_id
end

#generation ⇒ String

Generation suffix of the contact

Returns:

  • (String) 


45
46
47
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 45

def generation
  @generation
end

#given_name ⇒ String

Given name (first name) of the contact

Returns:

  • (String) 


48
49
50
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 48

def given_name
  @given_name
end

#initials ⇒ String

Initials of the contact

Returns:

  • (String) 


51
52
53
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 51

def initials
  @initials
end

#middle_name ⇒ String

Middle name of the contact

Returns:

  • (String) 


54
55
56
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 54

def middle_name
  @middle_name
end

#nickname ⇒ String

Nickname of the contact

Returns:

  • (String) 


57
58
59
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 57

def nickname
  @nickname
end

#surname ⇒ String

Surname (family name) of the contact

Returns:

  • (String) 


60
61
62
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 60

def surname
  @surname
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


164
165
166
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



170
171
172
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



129
130
131
132
133
134
135
136
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 250

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



244
245
246
 
# File 'lib/aspose-email-cloud/models/mapi_contact_name_property_set_dto.rb', line 244

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



140
141
142
143
 
# 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