Class: SwaggerClient::ClassDetails
- Inherits:
-
Object
- Object
- SwaggerClient::ClassDetails
- Defined in:
- lib/swagger_client/models/class_details.rb
Overview
A classroom
Instance Attribute Summary collapse
-
#assignments_count ⇒ Object
The number of assignments created in the class.
-
#canvas ⇒ Object
Returns the value of attribute canvas.
-
#clever ⇒ Object
Returns the value of attribute clever.
-
#creation_date ⇒ Object
The date when the class was create.
-
#description ⇒ Object
An optionnal description for this class.
-
#enrollment_code ⇒ Object
- Teachers only
-
The enrollment code that can be used by the students to join the class.
-
#google_classroom ⇒ Object
Returns the value of attribute google_classroom.
-
#google_drive ⇒ Object
Returns the value of attribute google_drive.
-
#id ⇒ Object
The unique identifier of the class.
-
#lti ⇒ Object
Returns the value of attribute lti.
-
#name ⇒ Object
The name of the class.
-
#organization ⇒ Object
The unique identifier of the Organization owning this class.
-
#owner ⇒ Object
The unique identifier of the User owning this class.
-
#section ⇒ Object
The section of the class.
-
#state ⇒ Object
Returns the value of attribute state.
-
#students_group ⇒ Object
Returns the value of attribute students_group.
-
#teachers_group ⇒ Object
Returns the value of attribute teachers_group.
-
#theme ⇒ Object
The theme identifier using in Flat User Interface.
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 = {}) ⇒ ClassDetails
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 = {}) ⇒ ClassDetails
Initializes the object
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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 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 |
# File 'lib/swagger_client/models/class_details.rb', line 115 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?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'section') self.section = attributes[:'section'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'organization') self.organization = attributes[:'organization'] end if attributes.has_key?(:'owner') self.owner = attributes[:'owner'] end if attributes.has_key?(:'creationDate') self.creation_date = attributes[:'creationDate'] end if attributes.has_key?(:'enrollmentCode') self.enrollment_code = attributes[:'enrollmentCode'] end if attributes.has_key?(:'theme') self.theme = attributes[:'theme'] end if attributes.has_key?(:'assignmentsCount') self.assignments_count = attributes[:'assignmentsCount'] end if attributes.has_key?(:'studentsGroup') self.students_group = attributes[:'studentsGroup'] end if attributes.has_key?(:'teachersGroup') self.teachers_group = attributes[:'teachersGroup'] end if attributes.has_key?(:'googleClassroom') self.google_classroom = attributes[:'googleClassroom'] end if attributes.has_key?(:'googleDrive') self.google_drive = attributes[:'googleDrive'] end if attributes.has_key?(:'lti') self.lti = attributes[:'lti'] end if attributes.has_key?(:'canvas') self.canvas = attributes[:'canvas'] end if attributes.has_key?(:'clever') self.clever = attributes[:'clever'] end end |
Instance Attribute Details
#assignments_count ⇒ Object
The number of assignments created in the class
48 49 50 |
# File 'lib/swagger_client/models/class_details.rb', line 48 def assignments_count @assignments_count end |
#canvas ⇒ Object
Returns the value of attribute canvas.
60 61 62 |
# File 'lib/swagger_client/models/class_details.rb', line 60 def canvas @canvas end |
#clever ⇒ Object
Returns the value of attribute clever.
62 63 64 |
# File 'lib/swagger_client/models/class_details.rb', line 62 def clever @clever end |
#creation_date ⇒ Object
The date when the class was create
39 40 41 |
# File 'lib/swagger_client/models/class_details.rb', line 39 def creation_date @creation_date end |
#description ⇒ Object
An optionnal description for this class
30 31 32 |
# File 'lib/swagger_client/models/class_details.rb', line 30 def description @description end |
#enrollment_code ⇒ Object
- Teachers only
-
The enrollment code that can be used by the students to join the class
42 43 44 |
# File 'lib/swagger_client/models/class_details.rb', line 42 def enrollment_code @enrollment_code end |
#google_classroom ⇒ Object
Returns the value of attribute google_classroom.
54 55 56 |
# File 'lib/swagger_client/models/class_details.rb', line 54 def google_classroom @google_classroom end |
#google_drive ⇒ Object
Returns the value of attribute google_drive.
56 57 58 |
# File 'lib/swagger_client/models/class_details.rb', line 56 def google_drive @google_drive end |
#id ⇒ Object
The unique identifier of the class
19 20 21 |
# File 'lib/swagger_client/models/class_details.rb', line 19 def id @id end |
#lti ⇒ Object
Returns the value of attribute lti.
58 59 60 |
# File 'lib/swagger_client/models/class_details.rb', line 58 def lti @lti end |
#name ⇒ Object
The name of the class
24 25 26 |
# File 'lib/swagger_client/models/class_details.rb', line 24 def name @name end |
#organization ⇒ Object
The unique identifier of the Organization owning this class
33 34 35 |
# File 'lib/swagger_client/models/class_details.rb', line 33 def organization @organization end |
#owner ⇒ Object
The unique identifier of the User owning this class
36 37 38 |
# File 'lib/swagger_client/models/class_details.rb', line 36 def owner @owner end |
#section ⇒ Object
The section of the class
27 28 29 |
# File 'lib/swagger_client/models/class_details.rb', line 27 def section @section end |
#state ⇒ Object
Returns the value of attribute state.
21 22 23 |
# File 'lib/swagger_client/models/class_details.rb', line 21 def state @state end |
#students_group ⇒ Object
Returns the value of attribute students_group.
50 51 52 |
# File 'lib/swagger_client/models/class_details.rb', line 50 def students_group @students_group end |
#teachers_group ⇒ Object
Returns the value of attribute teachers_group.
52 53 54 |
# File 'lib/swagger_client/models/class_details.rb', line 52 def teachers_group @teachers_group end |
#theme ⇒ Object
The theme identifier using in Flat User Interface
45 46 47 |
# File 'lib/swagger_client/models/class_details.rb', line 45 def theme @theme end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/swagger_client/models/class_details.rb', line 66 def self.attribute_map { :'id' => :'id', :'state' => :'state', :'name' => :'name', :'section' => :'section', :'description' => :'description', :'organization' => :'organization', :'owner' => :'owner', :'creation_date' => :'creationDate', :'enrollment_code' => :'enrollmentCode', :'theme' => :'theme', :'assignments_count' => :'assignmentsCount', :'students_group' => :'studentsGroup', :'teachers_group' => :'teachersGroup', :'google_classroom' => :'googleClassroom', :'google_drive' => :'googleDrive', :'lti' => :'lti', :'canvas' => :'canvas', :'clever' => :'clever' } end |
.swagger_types ⇒ Object
Attribute type mapping.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/swagger_client/models/class_details.rb', line 90 def self.swagger_types { :'id' => :'String', :'state' => :'ClassState', :'name' => :'String', :'section' => :'String', :'description' => :'String', :'organization' => :'String', :'owner' => :'String', :'creation_date' => :'DateTime', :'enrollment_code' => :'String', :'theme' => :'String', :'assignments_count' => :'Float', :'students_group' => :'GroupDetails', :'teachers_group' => :'GroupDetails', :'google_classroom' => :'ClassDetailsGoogleClassroom', :'google_drive' => :'ClassDetailsGoogleDrive', :'lti' => :'ClassDetailsLti', :'canvas' => :'ClassDetailsCanvas', :'clever' => :'ClassDetailsClever' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/swagger_client/models/class_details.rb', line 210 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && state == o.state && name == o.name && section == o.section && description == o.description && organization == o.organization && owner == o.owner && creation_date == o.creation_date && enrollment_code == o.enrollment_code && theme == o.theme && assignments_count == o.assignments_count && students_group == o.students_group && teachers_group == o.teachers_group && google_classroom == o.google_classroom && google_drive == o.google_drive && lti == o.lti && canvas == o.canvas && clever == o.clever end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
269 270 271 272 273 274 275 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 |
# File 'lib/swagger_client/models/class_details.rb', line 269 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 = SwaggerClient.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
335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/swagger_client/models/class_details.rb', line 335 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
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/swagger_client/models/class_details.rb', line 248 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 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
235 236 237 |
# File 'lib/swagger_client/models/class_details.rb', line 235 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
241 242 243 |
# File 'lib/swagger_client/models/class_details.rb', line 241 def hash [id, state, name, section, description, organization, owner, creation_date, enrollment_code, theme, assignments_count, students_group, teachers_group, google_classroom, google_drive, lti, canvas, clever].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
197 198 199 200 |
# File 'lib/swagger_client/models/class_details.rb', line 197 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
315 316 317 |
# File 'lib/swagger_client/models/class_details.rb', line 315 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
321 322 323 324 325 326 327 328 329 |
# File 'lib/swagger_client/models/class_details.rb', line 321 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
309 310 311 |
# File 'lib/swagger_client/models/class_details.rb', line 309 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
204 205 206 |
# File 'lib/swagger_client/models/class_details.rb', line 204 def valid? return true end |