class AsposeEmailCloud::MapiPidPropertyDescriptor
Mapi pid property descriptor base class
Attributes
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.
@return [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 @return [String]
Indicates if data type contains of multiple values
@return [BOOLEAN]
A string that identifies the property
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 51 def self.attribute_map { :'discriminator' => :'discriminator', :'canonical_name' => :'canonicalName', :'data_type' => :'dataType', :'multiple_values_data_type' => :'multipleValuesDataType', :'name' => :'name' } end
Initializes the object @param [String] canonical_name
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.
@param [String] data_type
[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 @param [BOOLEAN] multiple_values_data_type
Indicates if data type contains of multiple values
@param [String] name A string that identifies the property
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 77 def initialize(#, canonical_name: nil, data_type: nil, multiple_values_data_type: nil, name: 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 end
Attribute type mapping.
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 62 def self.swagger_types { :'discriminator' => :'String', :'canonical_name' => :'String', :'data_type' => :'String', :'multiple_values_data_type' => :'BOOLEAN', :'name' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 118 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 end
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_pid_property_descriptor.rb, line 166 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
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_pid_property_descriptor.rb, line 236 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
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_pid_property_descriptor.rb, line 143 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
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 31 def discriminator #getter method self.class.name.split('::').last end
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 35 def discriminator=(discriminator) #setter method, parameter ignored @discriminator = self.class.name.split('::').last end
@see the `==` method @param [Object] Object to be compared
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 130 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 136 def hash [discriminator, canonical_name, data_type, multiple_values_data_type, name].hash end
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_pid_property_descriptor.rb, line 90 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 invalid_properties end
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_pid_property_descriptor.rb, line 222 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose-email-cloud/models/mapi_pid_property_descriptor.rb, line 210 def to_s to_hash.to_s end
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_pid_property_descriptor.rb, line 109 def valid? return false if @discriminator.nil? return false if @data_type.nil? return false if @multiple_values_data_type.nil? true end