Class: AsposeEmailCloud::CalendarReminder

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

Overview

Provides a grouping of component properties that define an alarm.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(action: nil, attachments: nil, attendees: nil, description: nil, duration: nil, repeat: nil, summary: nil, trigger: nil) ⇒ CalendarReminder

Initializes the object

Parameters:

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

    Defines the action to be invoked when an alarm is triggered. Enum, available values: Audio, Display, Email, Procedure, None

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

    Collection of Reminder Attachments. Could be an absolute URI or Base64 string representation of attachment content

  • attendees (Array<ReminderAttendee>) (defaults to: nil) —

    Contains collection of ReminderAttendee objects.

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

    Provides a more complete description of the alarm.

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

    Specifies the delay period in ticks, after which the alarm will repeat.

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

    Defines the number of time the alarm should be repeated, after the initial trigger.

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

    Defines a short summary or subject for the alarm.

  • trigger (ReminderTrigger) (defaults to: nil) —

    Specifies when an alarm will trigger.



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

def initialize(
  action: nil,
  attachments: nil,
  attendees: nil,
  description: nil,
  duration: nil,
  repeat: nil,
  summary: nil,
  trigger: nil)
  self.action = action if action
  self.attachments = attachments if attachments
  self.attendees = attendees if attendees
  self.description = description if description
  self.duration = duration if duration
  self.repeat = repeat if repeat
  self.summary = summary if summary
  self.trigger = trigger if trigger
end

Instance Attribute Details

#action ⇒ String

Defines the action to be invoked when an alarm is triggered. Enum, available values: Audio, Display, Email, Procedure, None

Returns:

  • (String) 


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

def action
  @action
end

#attachments ⇒ Array<String>

Collection of Reminder Attachments. Could be an absolute URI or Base64 string representation of attachment content

Returns:

  • (Array<String>) 


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

def attachments
  @attachments
end

#attendees ⇒ Array<ReminderAttendee>

Contains collection of ReminderAttendee objects.

Returns:



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

def attendees
  @attendees
end

#description ⇒ String

Provides a more complete description of the alarm.

Returns:

  • (String) 


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

def description
  @description
end

#duration ⇒ Integer

Specifies the delay period in ticks, after which the alarm will repeat.

Returns:

  • (Integer) 


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

def duration
  @duration
end

#repeat ⇒ Integer

Defines the number of time the alarm should be repeated, after the initial trigger.

Returns:

  • (Integer) 


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

def repeat
  @repeat
end

#summary ⇒ String

Defines a short summary or subject for the alarm.

Returns:

  • (String) 


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

def summary
  @summary
end

#trigger ⇒ ReminderTrigger

Specifies when an alarm will trigger.

Returns:



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

def trigger
  @trigger
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 56

def self.attribute_map
  {
    :'action' => :'action',
    :'attachments' => :'attachments',
    :'attendees' => :'attendees',
    :'description' => :'description',
    :'duration' => :'duration',
    :'repeat' => :'repeat',
    :'summary' => :'summary',
    :'trigger' => :'trigger'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 70

def self.swagger_types
  {
    :'action' => :'String',
    :'attachments' => :'Array<String>',
    :'attendees' => :'Array<ReminderAttendee>',
    :'description' => :'String',
    :'duration' => :'Integer',
    :'repeat' => :'Integer',
    :'summary' => :'String',
    :'trigger' => :'ReminderTrigger'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      attachments == o.attachments &&
      attendees == o.attendees &&
      description == o.description &&
      duration == o.duration &&
      repeat == o.repeat &&
      summary == o.summary &&
      trigger == o.trigger
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



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
221
222
223
224
225
226
227
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 187

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 257

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 164

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


151
152
153
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 157

def hash
  [action, attachments, attendees, description, duration, repeat, summary, trigger].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



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 113

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

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



237
238
239
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 237

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 243

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



231
232
233
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 231

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



128
129
130
131
132
 
# File 'lib/aspose-email-cloud/models/calendar_reminder.rb', line 128

def valid?
  return false if @action.nil?
  return false if @repeat.nil?
  true
end