Class: RusticiSoftwareCloudV2::CreateDispatchSchema
- Inherits:
-
Object
- Object
- RusticiSoftwareCloudV2::CreateDispatchSchema
- Defined in:
- lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb
Instance Attribute Summary collapse
-
#allow_new_registrations ⇒ Object
If true, then new registrations can be created for this dispatch.
-
#course_id ⇒ Object
Id of the course to be dispatched.
-
#destination_id ⇒ Object
Id of the destination this dispatch will belong to.
-
#email ⇒ Object
SCORM Cloud user e-mail associated with this dispatch.
-
#enabled ⇒ Object
If true, then this dispatch can be launched.
-
#expiration_date ⇒ Object
The ISO 8601 TimeStamp (defaults to UTC) after which this dispatch will be disabled.
-
#instanced ⇒ Object
If true, then a new registration instance will be created if the client LMS doesn’t provide launch data for an existing one.
-
#notes ⇒ Object
Any provided notes about this dispatch.
-
#post_back ⇒ Object
The postback information for this Dispatch.
-
#registration_cap ⇒ Object
The maximum number of registrations that can be created for this dispatch, where ‘0’ means ‘unlimited registrations’.
-
#tags ⇒ Object
The tags to associate with this Dispatch.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateDispatchSchema
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ CreateDispatchSchema
Initializes the object
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 86 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'destinationId') self.destination_id = attributes[:'destinationId'] end if attributes.has_key?(:'courseId') self.course_id = attributes[:'courseId'] end if attributes.has_key?(:'allowNewRegistrations') self.allow_new_registrations = attributes[:'allowNewRegistrations'] else self.allow_new_registrations = true end if attributes.has_key?(:'instanced') self.instanced = attributes[:'instanced'] else self.instanced = true end if attributes.has_key?(:'registrationCap') self.registration_cap = attributes[:'registrationCap'] else self.registration_cap = 0 end if attributes.has_key?(:'expirationDate') self.expiration_date = attributes[:'expirationDate'] end if attributes.has_key?(:'enabled') self.enabled = attributes[:'enabled'] else self.enabled = true end if attributes.has_key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self. = value end end if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'notes') self.notes = attributes[:'notes'] end if attributes.has_key?(:'postBack') self.post_back = attributes[:'postBack'] end end |
Instance Attribute Details
#allow_new_registrations ⇒ Object
If true, then new registrations can be created for this dispatch.
24 25 26 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 24 def allow_new_registrations @allow_new_registrations end |
#course_id ⇒ Object
Id of the course to be dispatched.
21 22 23 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 21 def course_id @course_id end |
#destination_id ⇒ Object
Id of the destination this dispatch will belong to.
18 19 20 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 18 def destination_id @destination_id end |
#email ⇒ Object
SCORM Cloud user e-mail associated with this dispatch. If this is not provided, it will default to the owner of the Realm.
42 43 44 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 42 def email @email end |
#enabled ⇒ Object
If true, then this dispatch can be launched.
36 37 38 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 36 def enabled @enabled end |
#expiration_date ⇒ Object
The ISO 8601 TimeStamp (defaults to UTC) after which this dispatch will be disabled. An empty value will represent no expiration date.
33 34 35 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 33 def expiration_date @expiration_date end |
#instanced ⇒ Object
If true, then a new registration instance will be created if the client LMS doesn’t provide launch data for an existing one. Otherwise, the same instance will always be used for the given cmi.learner_id.
27 28 29 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 27 def instanced @instanced end |
#notes ⇒ Object
Any provided notes about this dispatch.
45 46 47 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 45 def notes @notes end |
#post_back ⇒ Object
The postback information for this Dispatch.
48 49 50 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 48 def post_back @post_back end |
#registration_cap ⇒ Object
The maximum number of registrations that can be created for this dispatch, where ‘0’ means ‘unlimited registrations’.
30 31 32 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 30 def registration_cap @registration_cap end |
#tags ⇒ Object
The tags to associate with this Dispatch.
39 40 41 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 39 def @tags end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 51 def self.attribute_map { :'destination_id' => :'destinationId', :'course_id' => :'courseId', :'allow_new_registrations' => :'allowNewRegistrations', :'instanced' => :'instanced', :'registration_cap' => :'registrationCap', :'expiration_date' => :'expirationDate', :'enabled' => :'enabled', :'tags' => :'tags', :'email' => :'email', :'notes' => :'notes', :'post_back' => :'postBack' } end |
.swagger_types ⇒ Object
Attribute type mapping.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 68 def self.swagger_types { :'destination_id' => :'String', :'course_id' => :'String', :'allow_new_registrations' => :'BOOLEAN', :'instanced' => :'BOOLEAN', :'registration_cap' => :'Integer', :'expiration_date' => :'DateTime', :'enabled' => :'BOOLEAN', :'tags' => :'Array<String>', :'email' => :'String', :'notes' => :'String', :'post_back' => :'PostBackSchema' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 173 def ==(o) return true if self.equal?(o) self.class == o.class && destination_id == o.destination_id && course_id == o.course_id && allow_new_registrations == o.allow_new_registrations && instanced == o.instanced && registration_cap == o.registration_cap && expiration_date == o.expiration_date && enabled == o.enabled && == o. && email == o.email && notes == o.notes && post_back == o.post_back end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 225 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 temp_model = RusticiSoftwareCloudV2.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
291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 291 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
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 204 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[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
191 192 193 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 191 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
197 198 199 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 197 def hash [destination_id, course_id, allow_new_registrations, instanced, registration_cap, expiration_date, enabled, , email, notes, post_back].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 149 def list_invalid_properties invalid_properties = Array.new if @destination_id.nil? invalid_properties.push('invalid value for "destination_id", destination_id cannot be nil.') end if @course_id.nil? invalid_properties.push('invalid value for "course_id", course_id cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
271 272 273 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 271 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
277 278 279 280 281 282 283 284 285 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 277 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
265 266 267 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 265 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
164 165 166 167 168 |
# File 'lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb', line 164 def valid? return false if @destination_id.nil? return false if @course_id.nil? true end |