Class: AsposeEmailCloud::MapiPidNamePropertyDescriptor
- Inherits:
-
MapiPidPropertyDescriptor
- Object
- MapiPropertyDescriptor
- MapiPidPropertyDescriptor
- AsposeEmailCloud::MapiPidNamePropertyDescriptor
- Defined in:
- lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb
Overview
Property identified by a string name along with a property set
Instance Attribute Summary collapse
-
#canonical_name ⇒ String
The name used to refer to the property in the documentation.
-
#data_type ⇒ String
[MS-OXCDATA]: Data Structures.
-
#multiple_values_data_type ⇒ BOOLEAN
Indicates if data type contains of multiple values.
-
#name ⇒ String
A string that identifies the property.
-
#property_set ⇒ String
A GUID that identifies a group of properties with a similar purpose.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
#discriminator ⇒ Object
getter method.
-
#discriminator=(discriminator) ⇒ Object
setter method, parameter ignored.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(canonical_name: nil, data_type: nil, multiple_values_data_type: nil, name: nil, property_set: nil) ⇒ MapiPidNamePropertyDescriptor
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(canonical_name: nil, data_type: nil, multiple_values_data_type: nil, name: nil, property_set: nil) ⇒ MapiPidNamePropertyDescriptor
Initializes the object
83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 83 def initialize(#, canonical_name: nil, data_type: nil, multiple_values_data_type: nil, name: nil, property_set: nil) self.canonical_name = canonical_name if canonical_name self.data_type = data_type if data_type self.multiple_values_data_type = multiple_values_data_type if multiple_values_data_type self.name = name if name self.property_set = property_set if property_set end |
Instance Attribute Details
#canonical_name ⇒ String
The name used to refer to the property in the documentation. The prefix of the canonical name identifies the basic characteristics of a property to the implementer. The canonical naming structure uses three categories that are denoted by the following prefixes to the canonical property name: * PidLid prefix: Properties identified by an unsigned 32-bit quantity along with a property set. * PidName prefix: Properties identified by a string name along with a property set. * PidTag prefix: Properties identified by an unsigned 16-bit quantity.
40 41 42 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 40 def canonical_name @canonical_name end |
#data_type ⇒ String
[MS-OXCDATA]: Data Structures. Enum, available values: Unspecified, Null, Integer16, Integer32, Floating32, Floating64, Currency, FloatingTime, ErrorCode, Boolean, Integer64, String, String8, Time, Guid, ServerId, Restriction, RuleAction, Binary, MultipleInteger16, MultipleInteger32, MultipleFloating32, MultipleFloating64, MultipleCurrency, MultipleFloatingTime, MultipleBoolean, MultipleInteger64, MultipleString, MultipleString8, MultipleTime, MultipleGuid, MultipleBinary, Object
43 44 45 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 43 def data_type @data_type end |
#multiple_values_data_type ⇒ BOOLEAN
Indicates if data type contains of multiple values
46 47 48 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 46 def multiple_values_data_type @multiple_values_data_type end |
#name ⇒ String
A string that identifies the property
49 50 51 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 49 def name @name end |
#property_set ⇒ String
A GUID that identifies a group of properties with a similar purpose.
52 53 54 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 52 def property_set @property_set end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
54 55 56 57 58 59 60 61 62 63 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 54 def self.attribute_map { :'discriminator' => :'discriminator', :'canonical_name' => :'canonicalName', :'data_type' => :'dataType', :'multiple_values_data_type' => :'multipleValuesDataType', :'name' => :'name', :'property_set' => :'propertySet' } end |
.swagger_types ⇒ Object
Attribute type mapping.
66 67 68 69 70 71 72 73 74 75 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 66 def self.swagger_types { :'discriminator' => :'String', :'canonical_name' => :'String', :'data_type' => :'String', :'multiple_values_data_type' => :'BOOLEAN', :'name' => :'String', :'property_set' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
131 132 133 134 135 136 137 138 139 140 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 131 def ==(o) return true if self.equal?(o) self.class == o.class && discriminator == o.discriminator && canonical_name == o.canonical_name && data_type == o.data_type && multiple_values_data_type == o.multiple_values_data_type && name == o.name && property_set == o.property_set end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 180 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
250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 250 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
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 157 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 |
#discriminator ⇒ Object
getter method
31 32 33 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 31 def discriminator #getter method self.class.name.split('::').last end |
#discriminator=(discriminator) ⇒ Object
setter method, parameter ignored
35 36 37 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 35 def discriminator=(discriminator) #setter method, parameter ignored @discriminator = self.class.name.split('::').last end |
#eql?(o) ⇒ Boolean
144 145 146 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 144 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
150 151 152 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 150 def hash [discriminator, canonical_name, data_type, multiple_values_data_type, name, property_set].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 98 def list_invalid_properties invalid_properties = Array.new if @discriminator.nil? invalid_properties.push('invalid value for "discriminator", discriminator cannot be nil.') end if @data_type.nil? invalid_properties.push('invalid value for "data_type", data_type cannot be nil.') end if @multiple_values_data_type.nil? invalid_properties.push('invalid value for "multiple_values_data_type", multiple_values_data_type cannot be nil.') end if @property_set.nil? invalid_properties.push('invalid value for "property_set", property_set cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
230 231 232 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 230 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
236 237 238 239 240 241 242 243 244 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 236 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
224 225 226 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 224 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
121 122 123 124 125 126 127 |
# File 'lib/aspose-email-cloud/models/mapi_pid_name_property_descriptor.rb', line 121 def valid? return false if @discriminator.nil? return false if @data_type.nil? return false if @multiple_values_data_type.nil? return false if @property_set.nil? true end |