class AsposeEmailCloud::CalendarReminder
Provides a grouping of component properties that define an alarm.
Attributes
Defines the action to be invoked when an alarm is triggered. Enum, available values: Audio, Display, Email, Procedure, None @return [String]
Collection of Reminder Attachments. Could be an absolute URI or Base64 string representation of attachment content
@return [Array<String>]
Contains collection of ReminderAttendee
objects.
@return [Array<ReminderAttendee>]
Provides a more complete description of the alarm. @return [String]
Specifies the delay period in ticks, after which the alarm will repeat.
@return [Integer]
Defines the number of time the alarm should be repeated, after the initial trigger.
@return [Integer]
Defines a short summary or subject for the alarm. @return [String]
Specifies when an alarm will trigger. @return [ReminderTrigger]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [String] action Defines the action to be invoked when an alarm is triggered. Enum, available values: Audio, Display, Email, Procedure, None @param [Array<String>] attachments Collection of Reminder Attachments. Could be an absolute URI or Base64 string representation of attachment content
@param [Array<ReminderAttendee>] attendees Contains collection of ReminderAttendee
objects.
@param [String] description Provides a more complete description of the alarm. @param [Integer] duration Specifies the delay period in ticks, after which the alarm will repeat.
@param [Integer] repeat Defines the number of time the alarm should be repeated, after the initial trigger.
@param [String] summary Defines a short summary or subject for the alarm. @param [ReminderTrigger] trigger Specifies when an alarm will trigger.
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
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/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
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/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
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/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
@see the `==` method @param [Object] Object to be compared
# File lib/aspose-email-cloud/models/calendar_reminder.rb, line 151 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose-email-cloud/models/calendar_reminder.rb, line 157 def hash [action, attachments, attendees, description, duration, repeat, summary, trigger].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/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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose-email-cloud/models/calendar_reminder.rb, line 231 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/calendar_reminder.rb, line 128 def valid? return false if @action.nil? return false if @repeat.nil? true end