Class: RusticiSoftwareCloudV2::PublicInvitationSchema
- Inherits:
-
Object
- Object
- RusticiSoftwareCloudV2::PublicInvitationSchema
- Defined in:
- lib/rustici_software_cloud_v2/models/public_invitation_schema.rb
Instance Attribute Summary collapse
-
#allow_launch ⇒ Object
Determines if learners are allowed to launch the invitation.
-
#allow_new_registrations ⇒ Object
Determines if new registrations can be created for this public invitation.
-
#course_id ⇒ Object
Course Id for this Invitation.
-
#create_date ⇒ Object
The create date for the invitation.
-
#expiration_date ⇒ Object
The ISO 8601 TimeStamp (defaults to UTC) after which this invitation will expire and can no longer be launched.
-
#id ⇒ Object
The invitationId for this invitation.
-
#invitation_email ⇒ Object
Returns the value of attribute invitation_email.
-
#post_back ⇒ Object
Specifies a URL for which to post activity and status data in real time as the course is completed.
-
#registration_cap ⇒ Object
Integer value that represents the maximum number of registrations that can be created for a public invitation.
-
#registration_count ⇒ Object
The count of registrations for this invitation.
-
#updated ⇒ Object
Returns the value of attribute updated.
-
#url ⇒ Object
The launch URL for the invitation.
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 = {}) ⇒ PublicInvitationSchema
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 = {}) ⇒ PublicInvitationSchema
Initializes the object
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 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 89 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'courseId') self.course_id = attributes[:'courseId'] end if attributes.has_key?(:'allowLaunch') self.allow_launch = attributes[:'allowLaunch'] end if attributes.has_key?(:'invitationEmail') self.invitation_email = attributes[:'invitationEmail'] end if attributes.has_key?(:'allowNewRegistrations') self.allow_new_registrations = attributes[:'allowNewRegistrations'] end if attributes.has_key?(:'url') self.url = attributes[:'url'] end if attributes.has_key?(:'createDate') self.create_date = attributes[:'createDate'] end if attributes.has_key?(:'updated') self.updated = attributes[:'updated'] end if attributes.has_key?(:'postBack') self.post_back = attributes[:'postBack'] end if attributes.has_key?(:'expirationDate') self.expiration_date = attributes[:'expirationDate'] end if attributes.has_key?(:'registrationCap') self.registration_cap = attributes[:'registrationCap'] else self.registration_cap = 0 end if attributes.has_key?(:'registrationCount') self.registration_count = attributes[:'registrationCount'] end end |
Instance Attribute Details
#allow_launch ⇒ Object
Determines if learners are allowed to launch the invitation. If false, the invitation is disabled and no new or existing learners are allowed to launch it.
24 25 26 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 24 def allow_launch @allow_launch end |
#allow_new_registrations ⇒ Object
Determines if new registrations can be created for this public invitation. If false, no new registrations can be created for the invitation, so only learners with existing registrations can access the invitation.
29 30 31 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 29 def allow_new_registrations @allow_new_registrations end |
#course_id ⇒ Object
Course Id for this Invitation.
21 22 23 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 21 def course_id @course_id end |
#create_date ⇒ Object
The create date for the invitation
35 36 37 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 35 def create_date @create_date end |
#expiration_date ⇒ Object
The ISO 8601 TimeStamp (defaults to UTC) after which this invitation will expire and can no longer be launched. An empty value will represent no expiration date.
43 44 45 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 43 def expiration_date @expiration_date end |
#id ⇒ Object
The invitationId for this invitation.
18 19 20 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 18 def id @id end |
#invitation_email ⇒ Object
Returns the value of attribute invitation_email.
26 27 28 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 26 def invitation_email @invitation_email end |
#post_back ⇒ Object
Specifies a URL for which to post activity and status data in real time as the course is completed
40 41 42 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 40 def post_back @post_back end |
#registration_cap ⇒ Object
Integer value that represents the maximum number of registrations that can be created for a public invitation. Setting this value to ‘0’ allows an unlimited amount of registrations to be created for the invitation.
46 47 48 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 46 def registration_cap @registration_cap end |
#registration_count ⇒ Object
The count of registrations for this invitation
49 50 51 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 49 def registration_count @registration_count end |
#updated ⇒ Object
Returns the value of attribute updated.
37 38 39 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 37 def updated @updated end |
#url ⇒ Object
The launch URL for the invitation
32 33 34 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 32 def url @url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 52 def self.attribute_map { :'id' => :'id', :'course_id' => :'courseId', :'allow_launch' => :'allowLaunch', :'invitation_email' => :'invitationEmail', :'allow_new_registrations' => :'allowNewRegistrations', :'url' => :'url', :'create_date' => :'createDate', :'updated' => :'updated', :'post_back' => :'postBack', :'expiration_date' => :'expirationDate', :'registration_cap' => :'registrationCap', :'registration_count' => :'registrationCount' } end |
.swagger_types ⇒ Object
Attribute type mapping.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 70 def self.swagger_types { :'id' => :'String', :'course_id' => :'String', :'allow_launch' => :'BOOLEAN', :'invitation_email' => :'InvitationEmailSchema', :'allow_new_registrations' => :'BOOLEAN', :'url' => :'String', :'create_date' => :'DateTime', :'updated' => :'DateTime', :'post_back' => :'PostBackSchema', :'expiration_date' => :'DateTime', :'registration_cap' => :'Integer', :'registration_count' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 162 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && course_id == o.course_id && allow_launch == o.allow_launch && invitation_email == o.invitation_email && allow_new_registrations == o.allow_new_registrations && url == o.url && create_date == o.create_date && updated == o.updated && post_back == o.post_back && expiration_date == o.expiration_date && registration_cap == o.registration_cap && registration_count == o.registration_count end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
215 216 217 218 219 220 221 222 223 224 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 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 215 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
281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 281 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
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 194 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
181 182 183 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 181 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
187 188 189 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 187 def hash [id, course_id, allow_launch, invitation_email, allow_new_registrations, url, create_date, updated, post_back, expiration_date, registration_cap, registration_count].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
148 149 150 151 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 148 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
261 262 263 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 261 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
267 268 269 270 271 272 273 274 275 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 267 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
255 256 257 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 255 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
155 156 157 |
# File 'lib/rustici_software_cloud_v2/models/public_invitation_schema.rb', line 155 def valid? true end |