Class: AsposeEmailCloud::MapiCalendarEventRecurrenceDto

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

Overview

Recurrence properties of calendar object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(appointment_time_zone_definition_recur: nil, clip_end: nil, clip_start: nil, is_exception: nil, recurrence_pattern: nil, time_zone_struct: nil) ⇒ MapiCalendarEventRecurrenceDto

Initializes the object

Parameters:

  • appointment_time_zone_definition_recur (MapiCalendarTimeZoneDto) (defaults to: nil) —

    Time zone information that describes how to convert the meeting date and time on a recurring series to and from UTC.

  • clip_end (DateTime) (defaults to: nil) —

    Date of the last instance.

  • clip_start (DateTime) (defaults to: nil) —

    Date of the first instance.

  • is_exception (BOOLEAN) (defaults to: nil) —

    Value indicating whether the object represents an exception.

  • recurrence_pattern (MapiCalendarRecurrencePatternDto) (defaults to: nil) —

    Recurrence pattern.

  • time_zone_struct (MapiCalendarTimeZoneDto) (defaults to: nil) —

    Time zone information for a recurring meeting.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 80

def initialize(
  appointment_time_zone_definition_recur: nil,
  clip_end: nil,
  clip_start: nil,
  is_exception: nil,
  recurrence_pattern: nil,
  time_zone_struct: nil)
  self.appointment_time_zone_definition_recur = appointment_time_zone_definition_recur if appointment_time_zone_definition_recur
  self.clip_end = clip_end if clip_end
  self.clip_start = clip_start if clip_start
  self.is_exception = is_exception if is_exception
  self.recurrence_pattern = recurrence_pattern if recurrence_pattern
  self.time_zone_struct = time_zone_struct if time_zone_struct
end

Instance Attribute Details

#appointment_time_zone_definition_recur ⇒ MapiCalendarTimeZoneDto

Time zone information that describes how to convert the meeting date and time on a recurring series to and from UTC.

Returns:



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

def appointment_time_zone_definition_recur
  @appointment_time_zone_definition_recur
end

#clip_end ⇒ DateTime

Date of the last instance.

Returns:

  • (DateTime) 


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

def clip_end
  @clip_end
end

#clip_start ⇒ DateTime

Date of the first instance.

Returns:

  • (DateTime) 


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

def clip_start
  @clip_start
end

#is_exception ⇒ BOOLEAN

Value indicating whether the object represents an exception.

Returns:

  • (BOOLEAN) 


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

def is_exception
  @is_exception
end

#recurrence_pattern ⇒ MapiCalendarRecurrencePatternDto

Recurrence pattern.

Returns:



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

def recurrence_pattern
  @recurrence_pattern
end

#time_zone_struct ⇒ MapiCalendarTimeZoneDto

Time zone information for a recurring meeting.

Returns:



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

def time_zone_struct
  @time_zone_struct
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 50

def self.attribute_map
  {
    :'appointment_time_zone_definition_recur' => :'appointmentTimeZoneDefinitionRecur',
    :'clip_end' => :'clipEnd',
    :'clip_start' => :'clipStart',
    :'is_exception' => :'isException',
    :'recurrence_pattern' => :'recurrencePattern',
    :'time_zone_struct' => :'timeZoneStruct'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 62

def self.swagger_types
  {
    :'appointment_time_zone_definition_recur' => :'MapiCalendarTimeZoneDto',
    :'clip_end' => :'DateTime',
    :'clip_start' => :'DateTime',
    :'is_exception' => :'BOOLEAN',
    :'recurrence_pattern' => :'MapiCalendarRecurrencePatternDto',
    :'time_zone_struct' => :'MapiCalendarTimeZoneDto'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      appointment_time_zone_definition_recur == o.appointment_time_zone_definition_recur &&
      clip_end == o.clip_end &&
      clip_start == o.clip_start &&
      is_exception == o.is_exception &&
      recurrence_pattern == o.recurrence_pattern &&
      time_zone_struct == o.time_zone_struct
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



174
175
176
177
178
179
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
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 174

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



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 244

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 151

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


138
139
140
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 144

def hash
  [appointment_time_zone_definition_recur, clip_end, clip_start, is_exception, recurrence_pattern, time_zone_struct].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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 97

def list_invalid_properties
  invalid_properties = Array.new
  if @clip_end.nil?
    invalid_properties.push('invalid value for "clip_end", clip_end cannot be nil.')
  end

  if @clip_start.nil?
    invalid_properties.push('invalid value for "clip_start", clip_start cannot be nil.')
  end

  if @is_exception.nil?
    invalid_properties.push('invalid value for "is_exception", is_exception 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



224
225
226
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 224

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



230
231
232
233
234
235
236
237
238
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 230

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



218
219
220
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 218

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



116
117
118
119
120
121
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_event_recurrence_dto.rb', line 116

def valid?
  return false if @clip_end.nil?
  return false if @clip_start.nil?
  return false if @is_exception.nil?
  true
end