Class: AsposeEmailCloud::MapiCalendarExceptionInfoDto

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

Overview

An exception specifies changes to an instance of a recurring series.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attachments: nil, body: nil, busy_status: nil, end_date_time: nil, has_attachment: nil, location: nil, meeting_type: nil, original_start_date: nil, override_flags: nil, reminder_delta: nil, reminder_set: nil, start_date_time: nil, subject: nil, sub_type: nil) ⇒ MapiCalendarExceptionInfoDto

Initializes the object

Parameters:

  • attachments (Array<MapiAttachmentDto>) (defaults to: nil) —

    Attachments in the recurrence exception.

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

    Body.

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

    Enumerates the mapi calendar possible busy status. Enum, available values: Free, Tentative, Busy, OutOfOffice

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

    End date.

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

    Value of this field specifies whether the Exception Embedded Message object contains attachments.

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

    Location.

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

    Enumerates the appointment state. Enum, available values: Meeting, Received, Canceled

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

    Original start date.

  • override_flags (Array<String>) (defaults to: nil) —

    Override flags. Items: Specifies what data in the MapiCalendarOverride structure has a value different from the recurring series. Enum, available values: Subject, MeetingType, ReminderDelta, Reminder, Location, BusyStatus, Attachment, Subtype, AppointmentColor, ExceptionalBody

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

    Reminder delta.

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

    Value for the PidLidReminderSet property.

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

    Start date.

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

    Subject.

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

    SubType.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 128

def initialize(
  attachments: nil,
  body: nil,
  busy_status: nil,
  end_date_time: nil,
  has_attachment: nil,
  location: nil,
  meeting_type: nil,
  original_start_date: nil,
  override_flags: nil,
  reminder_delta: nil,
  reminder_set: nil,
  start_date_time: nil,
  subject: nil,
  sub_type: nil)
  self.attachments = attachments if attachments
  self.body = body if body
  self.busy_status = busy_status if busy_status
  self.end_date_time = end_date_time if end_date_time
  self.has_attachment = has_attachment if has_attachment
  self.location = location if location
  self.meeting_type = meeting_type if meeting_type
  self.original_start_date = original_start_date if original_start_date
  self.override_flags = override_flags if override_flags
  self.reminder_delta = reminder_delta if reminder_delta
  self.reminder_set = reminder_set if reminder_set
  self.start_date_time = start_date_time if start_date_time
  self.subject = subject if subject
  self.sub_type = sub_type if sub_type
end

Instance Attribute Details

#attachments ⇒ Array<MapiAttachmentDto>

Attachments in the recurrence exception.

Returns:



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

def attachments
  @attachments
end

#body ⇒ String

Body.

Returns:

  • (String) 


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

def body
  @body
end

#busy_status ⇒ String

Enumerates the mapi calendar possible busy status. Enum, available values: Free, Tentative, Busy, OutOfOffice

Returns:

  • (String) 


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

def busy_status
  @busy_status
end

#end_date_time ⇒ DateTime

End date.

Returns:

  • (DateTime) 


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

def end_date_time
  @end_date_time
end

#has_attachment ⇒ BOOLEAN

Value of this field specifies whether the Exception Embedded Message object contains attachments.

Returns:

  • (BOOLEAN) 


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

def has_attachment
  @has_attachment
end

#location ⇒ String

Location.

Returns:

  • (String) 


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

def location
  @location
end

#meeting_type ⇒ String

Enumerates the appointment state. Enum, available values: Meeting, Received, Canceled

Returns:

  • (String) 


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

def meeting_type
  @meeting_type
end

#original_start_date ⇒ DateTime

Original start date.

Returns:

  • (DateTime) 


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

def original_start_date
  @original_start_date
end

#override_flags ⇒ Array<String>

Override flags. Items: Specifies what data in the MapiCalendarOverride structure has a value different from the recurring series. Enum, available values: Subject, MeetingType, ReminderDelta, Reminder, Location, BusyStatus, Attachment, Subtype, AppointmentColor, ExceptionalBody

Returns:

  • (Array<String>) 


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

def override_flags
  @override_flags
end

#reminder_delta ⇒ Integer

Reminder delta.

Returns:

  • (Integer) 


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

def reminder_delta
  @reminder_delta
end

#reminder_set ⇒ BOOLEAN

Value for the PidLidReminderSet property.

Returns:

  • (BOOLEAN) 


63
64
65
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 63

def reminder_set
  @reminder_set
end

#start_date_time ⇒ DateTime

Start date.

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 66

def start_date_time
  @start_date_time
end

#sub_type ⇒ Integer

SubType.

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 72

def sub_type
  @sub_type
end

#subject ⇒ String

Subject.

Returns:

  • (String) 


69
70
71
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 69

def subject
  @subject
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 74

def self.attribute_map
  {
    :'attachments' => :'attachments',
    :'body' => :'body',
    :'busy_status' => :'busyStatus',
    :'end_date_time' => :'endDateTime',
    :'has_attachment' => :'hasAttachment',
    :'location' => :'location',
    :'meeting_type' => :'meetingType',
    :'original_start_date' => :'originalStartDate',
    :'override_flags' => :'overrideFlags',
    :'reminder_delta' => :'reminderDelta',
    :'reminder_set' => :'reminderSet',
    :'start_date_time' => :'startDateTime',
    :'subject' => :'subject',
    :'sub_type' => :'subType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'attachments' => :'Array<MapiAttachmentDto>',
    :'body' => :'String',
    :'busy_status' => :'String',
    :'end_date_time' => :'DateTime',
    :'has_attachment' => :'BOOLEAN',
    :'location' => :'String',
    :'meeting_type' => :'String',
    :'original_start_date' => :'DateTime',
    :'override_flags' => :'Array<String>',
    :'reminder_delta' => :'Integer',
    :'reminder_set' => :'BOOLEAN',
    :'start_date_time' => :'DateTime',
    :'subject' => :'String',
    :'sub_type' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attachments == o.attachments &&
      body == o.body &&
      busy_status == o.busy_status &&
      end_date_time == o.end_date_time &&
      has_attachment == o.has_attachment &&
      location == o.location &&
      meeting_type == o.meeting_type &&
      original_start_date == o.original_start_date &&
      override_flags == o.override_flags &&
      reminder_delta == o.reminder_delta &&
      reminder_set == o.reminder_set &&
      start_date_time == o.start_date_time &&
      subject == o.subject &&
      sub_type == o.sub_type
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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 276

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 346

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 253

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


240
241
242
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



246
247
248
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 246

def hash
  [attachments, body, busy_status, end_date_time, has_attachment, location, meeting_type, original_start_date, override_flags, reminder_delta, reminder_set, start_date_time, subject, sub_type].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



161
162
163
164
165
166
167
168
169
170
171
172
173
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
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 161

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

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

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

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

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

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

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

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

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



326
327
328
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 326

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



332
333
334
335
336
337
338
339
340
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 332

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



320
321
322
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 320

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



204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/aspose-email-cloud/models/mapi_calendar_exception_info_dto.rb', line 204

def valid?
  return false if @busy_status.nil?
  return false if @end_date_time.nil?
  return false if @has_attachment.nil?
  return false if @meeting_type.nil?
  return false if @original_start_date.nil?
  return false if @reminder_delta.nil?
  return false if @reminder_set.nil?
  return false if @start_date_time.nil?
  return false if @sub_type.nil?
  true
end