Class: MicrosoftGraph::Models::EducationAssignment

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/education_assignment.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new educationAssignment and sets the default values.



242
243
244
 
# File 'lib/models/education_assignment.rb', line 242

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Raises:

  • (StandardError) 


280
281
282
283
 
# File 'lib/models/education_assignment.rb', line 280

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return EducationAssignment.new
end

Instance Method Details

#add_to_calendar_action ⇒ Object

Gets the addToCalendarAction property value. Optional field to control the assignment behavior for adding assignments to students’ and teachers’ calendars when the assignment is published. The possible values are: none, studentsAndPublisher, studentsAndTeamOwners, unknownFutureValue, and studentsOnly. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value(s) in this evolvable enum: studentsOnly. The default value is none.



92
93
94
 
# File 'lib/models/education_assignment.rb', line 92

def add_to_calendar_action
    return @add_to_calendar_action
end

#add_to_calendar_action=(value) ⇒ Object

Sets the addToCalendarAction property value. Optional field to control the assignment behavior for adding assignments to students’ and teachers’ calendars when the assignment is published. The possible values are: none, studentsAndPublisher, studentsAndTeamOwners, unknownFutureValue, and studentsOnly. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value(s) in this evolvable enum: studentsOnly. The default value is none.



100
101
102
 
# File 'lib/models/education_assignment.rb', line 100

def add_to_calendar_action=(value)
    @add_to_calendar_action = value
end

#added_student_action ⇒ Object

Gets the addedStudentAction property value. Optional field to control the assignment behavior for students who are added after the assignment is published. If not specified, defaults to none. Supported values are: none, assignIfOpen. For example, a teacher can use assignIfOpen to indicate that an assignment should be assigned to any new student who joins the class while the assignment is still open, and none to indicate that an assignment should not be assigned to new students.



107
108
109
 
# File 'lib/models/education_assignment.rb', line 107

def added_student_action
    return @added_student_action
end

#added_student_action=(value) ⇒ Object

Sets the addedStudentAction property value. Optional field to control the assignment behavior for students who are added after the assignment is published. If not specified, defaults to none. Supported values are: none, assignIfOpen. For example, a teacher can use assignIfOpen to indicate that an assignment should be assigned to any new student who joins the class while the assignment is still open, and none to indicate that an assignment should not be assigned to new students.



115
116
117
 
# File 'lib/models/education_assignment.rb', line 115

def added_student_action=(value)
    @added_student_action = value
end

#allow_late_submissions ⇒ Object

Gets the allowLateSubmissions property value. Identifies whether students can submit after the due date. If this property isn’t specified during create, it defaults to true.



122
123
124
 
# File 'lib/models/education_assignment.rb', line 122

def allow_late_submissions
    return @allow_late_submissions
end

#allow_late_submissions=(value) ⇒ Object

Sets the allowLateSubmissions property value. Identifies whether students can submit after the due date. If this property isn’t specified during create, it defaults to true.



130
131
132
 
# File 'lib/models/education_assignment.rb', line 130

def allow_late_submissions=(value)
    @allow_late_submissions = value
end

#allow_students_to_add_resources_to_submission ⇒ Object

Gets the allowStudentsToAddResourcesToSubmission property value. Identifies whether students can add their own resources to a submission or if they can only modify resources added by the teacher.



137
138
139
 
# File 'lib/models/education_assignment.rb', line 137

def allow_students_to_add_resources_to_submission
    return @allow_students_to_add_resources_to_submission
end

#allow_students_to_add_resources_to_submission=(value) ⇒ Object

Sets the allowStudentsToAddResourcesToSubmission property value. Identifies whether students can add their own resources to a submission or if they can only modify resources added by the teacher.



145
146
147
 
# File 'lib/models/education_assignment.rb', line 145

def allow_students_to_add_resources_to_submission=(value)
    @allow_students_to_add_resources_to_submission = value
end

#assign_date_time ⇒ Object

Gets the assignDateTime property value. The date when the assignment should become active. If in the future, the assignment isn’t shown to the student until this date. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



152
153
154
 
# File 'lib/models/education_assignment.rb', line 152

def assign_date_time
    return @assign_date_time
end

#assign_date_time=(value) ⇒ Object

Sets the assignDateTime property value. The date when the assignment should become active. If in the future, the assignment isn’t shown to the student until this date. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



160
161
162
 
# File 'lib/models/education_assignment.rb', line 160

def assign_date_time=(value)
    @assign_date_time = value
end

#assign_to ⇒ Object

Gets the assignTo property value. Which users, or whole class should receive a submission object once the assignment is published.



167
168
169
 
# File 'lib/models/education_assignment.rb', line 167

def assign_to
    return @assign_to
end

#assign_to=(value) ⇒ Object

Sets the assignTo property value. Which users, or whole class should receive a submission object once the assignment is published.



175
176
177
 
# File 'lib/models/education_assignment.rb', line 175

def assign_to=(value)
    @assign_to = value
end

#assigned_date_time ⇒ Object

Gets the assignedDateTime property value. The moment that the assignment was published to students and the assignment shows up on the students timeline. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



182
183
184
 
# File 'lib/models/education_assignment.rb', line 182

def assigned_date_time
    return @assigned_date_time
end

#assigned_date_time=(value) ⇒ Object

Sets the assignedDateTime property value. The moment that the assignment was published to students and the assignment shows up on the students timeline. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



190
191
192
 
# File 'lib/models/education_assignment.rb', line 190

def assigned_date_time=(value)
    @assigned_date_time = value
end

#categories ⇒ Object

Gets the categories property value. When set, enables users to easily find assignments of a given type. Read-only. Nullable.



197
198
199
 
# File 'lib/models/education_assignment.rb', line 197

def categories
    return @categories
end

#categories=(value) ⇒ Object

Sets the categories property value. When set, enables users to easily find assignments of a given type. Read-only. Nullable.



205
206
207
 
# File 'lib/models/education_assignment.rb', line 205

def categories=(value)
    @categories = value
end

#class_id ⇒ Object

Gets the classId property value. Class which this assignment belongs.



212
213
214
 
# File 'lib/models/education_assignment.rb', line 212

def class_id
    return @class_id
end

#class_id=(value) ⇒ Object

Sets the classId property value. Class which this assignment belongs.



220
221
222
 
# File 'lib/models/education_assignment.rb', line 220

def class_id=(value)
    @class_id = value
end

#close_date_time ⇒ Object

Gets the closeDateTime property value. Date when the assignment will be closed for submissions. This is an optional field that can be null if the assignment does not allowLateSubmissions or when the closeDateTime is the same as the dueDateTime. But if specified, then the closeDateTime must be greater than or equal to the dueDateTime. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



227
228
229
 
# File 'lib/models/education_assignment.rb', line 227

def close_date_time
    return @close_date_time
end

#close_date_time=(value) ⇒ Object

Sets the closeDateTime property value. Date when the assignment will be closed for submissions. This is an optional field that can be null if the assignment does not allowLateSubmissions or when the closeDateTime is the same as the dueDateTime. But if specified, then the closeDateTime must be greater than or equal to the dueDateTime. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



235
236
237
 
# File 'lib/models/education_assignment.rb', line 235

def close_date_time=(value)
    @close_date_time = value
end

#created_by ⇒ Object

Gets the createdBy property value. Who created the assignment.



249
250
251
 
# File 'lib/models/education_assignment.rb', line 249

def created_by
    return @created_by
end

#created_by=(value) ⇒ Object

Sets the createdBy property value. Who created the assignment.



257
258
259
 
# File 'lib/models/education_assignment.rb', line 257

def created_by=(value)
    @created_by = value
end

#created_date_time ⇒ Object

Gets the createdDateTime property value. Moment when the assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



264
265
266
 
# File 'lib/models/education_assignment.rb', line 264

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. Moment when the assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



272
273
274
 
# File 'lib/models/education_assignment.rb', line 272

def created_date_time=(value)
    @created_date_time = value
end

#display_name ⇒ Object

Gets the displayName property value. Name of the assignment.



288
289
290
 
# File 'lib/models/education_assignment.rb', line 288

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. Name of the assignment.



296
297
298
 
# File 'lib/models/education_assignment.rb', line 296

def display_name=(value)
    @display_name = value
end

#due_date_time ⇒ Object

Gets the dueDateTime property value. Date when the students assignment is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



303
304
305
 
# File 'lib/models/education_assignment.rb', line 303

def due_date_time
    return @due_date_time
end

#due_date_time=(value) ⇒ Object

Sets the dueDateTime property value. Date when the students assignment is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



311
312
313
 
# File 'lib/models/education_assignment.rb', line 311

def due_date_time=(value)
    @due_date_time = value
end

#feedback_resources_folder_url ⇒ Object

Gets the feedbackResourcesFolderUrl property value. Folder URL where all the feedback file resources for this assignment are stored.



318
319
320
 
# File 'lib/models/education_assignment.rb', line 318

def feedback_resources_folder_url
    return @feedback_resources_folder_url
end

#feedback_resources_folder_url=(value) ⇒ Object

Sets the feedbackResourcesFolderUrl property value. Folder URL where all the feedback file resources for this assignment are stored.



326
327
328
 
# File 'lib/models/education_assignment.rb', line 326

def feedback_resources_folder_url=(value)
    @feedback_resources_folder_url = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/models/education_assignment.rb', line 333

def get_field_deserializers()
    return super.merge({
        "addToCalendarAction" => lambda {|n| @add_to_calendar_action = n.get_enum_value(MicrosoftGraph::Models::EducationAddToCalendarOptions) },
        "addedStudentAction" => lambda {|n| @added_student_action = n.get_enum_value(MicrosoftGraph::Models::EducationAddedStudentAction) },
        "allowLateSubmissions" => lambda {|n| @allow_late_submissions = n.get_boolean_value() },
        "allowStudentsToAddResourcesToSubmission" => lambda {|n| @allow_students_to_add_resources_to_submission = n.get_boolean_value() },
        "assignDateTime" => lambda {|n| @assign_date_time = n.get_date_time_value() },
        "assignTo" => lambda {|n| @assign_to = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationAssignmentRecipient.create_from_discriminator_value(pn) }) },
        "assignedDateTime" => lambda {|n| @assigned_date_time = n.get_date_time_value() },
        "categories" => lambda {|n| @categories = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationCategory.create_from_discriminator_value(pn) }) },
        "classId" => lambda {|n| @class_id = n.get_string_value() },
        "closeDateTime" => lambda {|n| @close_date_time = n.get_date_time_value() },
        "createdBy" => lambda {|n| @created_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentitySet.create_from_discriminator_value(pn) }) },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "dueDateTime" => lambda {|n| @due_date_time = n.get_date_time_value() },
        "feedbackResourcesFolderUrl" => lambda {|n| @feedback_resources_folder_url = n.get_string_value() },
        "grading" => lambda {|n| @grading = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationAssignmentGradeType.create_from_discriminator_value(pn) }) },
        "instructions" => lambda {|n| @instructions = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationItemBody.create_from_discriminator_value(pn) }) },
        "lastModifiedBy" => lambda {|n| @last_modified_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentitySet.create_from_discriminator_value(pn) }) },
        "lastModifiedDateTime" => lambda {|n| @last_modified_date_time = n.get_date_time_value() },
        "notificationChannelUrl" => lambda {|n| @notification_channel_url = n.get_string_value() },
        "resources" => lambda {|n| @resources = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationAssignmentResource.create_from_discriminator_value(pn) }) },
        "resourcesFolderUrl" => lambda {|n| @resources_folder_url = n.get_string_value() },
        "rubric" => lambda {|n| @rubric = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EducationRubric.create_from_discriminator_value(pn) }) },
        "status" => lambda {|n| @status = n.get_enum_value(MicrosoftGraph::Models::EducationAssignmentStatus) },
        "submissions" => lambda {|n| @submissions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::EducationSubmission.create_from_discriminator_value(pn) }) },
        "webUrl" => lambda {|n| @web_url = n.get_string_value() },
    })
end

#grading ⇒ Object

Gets the grading property value. How the assignment will be graded.



367
368
369
 
# File 'lib/models/education_assignment.rb', line 367

def grading
    return @grading
end

#grading=(value) ⇒ Object

Sets the grading property value. How the assignment will be graded.



375
376
377
 
# File 'lib/models/education_assignment.rb', line 375

def grading=(value)
    @grading = value
end

#instructions ⇒ Object

Gets the instructions property value. Instructions for the assignment. This along with the display name tell the student what to do.



382
383
384
 
# File 'lib/models/education_assignment.rb', line 382

def instructions
    return @instructions
end

#instructions=(value) ⇒ Object

Sets the instructions property value. Instructions for the assignment. This along with the display name tell the student what to do.



390
391
392
 
# File 'lib/models/education_assignment.rb', line 390

def instructions=(value)
    @instructions = value
end

#last_modified_by ⇒ Object

Gets the lastModifiedBy property value. Who last modified the assignment.



397
398
399
 
# File 'lib/models/education_assignment.rb', line 397

def last_modified_by
    return @last_modified_by
end

#last_modified_by=(value) ⇒ Object

Sets the lastModifiedBy property value. Who last modified the assignment.



405
406
407
 
# File 'lib/models/education_assignment.rb', line 405

def last_modified_by=(value)
    @last_modified_by = value
end

#last_modified_date_time ⇒ Object

Gets the lastModifiedDateTime property value. Moment when the assignment was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



412
413
414
 
# File 'lib/models/education_assignment.rb', line 412

def last_modified_date_time
    return @last_modified_date_time
end

#last_modified_date_time=(value) ⇒ Object

Sets the lastModifiedDateTime property value. Moment when the assignment was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z



420
421
422
 
# File 'lib/models/education_assignment.rb', line 420

def last_modified_date_time=(value)
    @last_modified_date_time = value
end

#notification_channel_url ⇒ Object

Gets the notificationChannelUrl property value. Optional field to specify the URL of the channel to post the assignment publish notification. If not specified or null, defaults to the General channel. This field only applies to assignments where the assignTo value is educationAssignmentClassRecipient. Updating the notificationChannelUrl isn’t allowed after the assignment has been published.



427
428
429
 
# File 'lib/models/education_assignment.rb', line 427

def notification_channel_url
    return @notification_channel_url
end

#notification_channel_url=(value) ⇒ Object

Sets the notificationChannelUrl property value. Optional field to specify the URL of the channel to post the assignment publish notification. If not specified or null, defaults to the General channel. This field only applies to assignments where the assignTo value is educationAssignmentClassRecipient. Updating the notificationChannelUrl isn’t allowed after the assignment has been published.



435
436
437
 
# File 'lib/models/education_assignment.rb', line 435

def notification_channel_url=(value)
    @notification_channel_url = value
end

#resources ⇒ Object

Gets the resources property value. Learning objects that are associated with this assignment. Only teachers can modify this list. Nullable.



442
443
444
 
# File 'lib/models/education_assignment.rb', line 442

def resources
    return @resources
end

#resources=(value) ⇒ Object

Sets the resources property value. Learning objects that are associated with this assignment. Only teachers can modify this list. Nullable.



450
451
452
 
# File 'lib/models/education_assignment.rb', line 450

def resources=(value)
    @resources = value
end

#resources_folder_url ⇒ Object

Gets the resourcesFolderUrl property value. Folder URL where all the file resources for this assignment are stored.



457
458
459
 
# File 'lib/models/education_assignment.rb', line 457

def resources_folder_url
    return @resources_folder_url
end

#resources_folder_url=(value) ⇒ Object

Sets the resourcesFolderUrl property value. Folder URL where all the file resources for this assignment are stored.



465
466
467
 
# File 'lib/models/education_assignment.rb', line 465

def resources_folder_url=(value)
    @resources_folder_url = value
end

#rubric ⇒ Object

Gets the rubric property value. When set, the grading rubric attached to this assignment.



472
473
474
 
# File 'lib/models/education_assignment.rb', line 472

def rubric
    return @rubric
end

#rubric=(value) ⇒ Object

Sets the rubric property value. When set, the grading rubric attached to this assignment.



480
481
482
 
# File 'lib/models/education_assignment.rb', line 480

def rubric=(value)
    @rubric = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Raises:

  • (StandardError) 


488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/models/education_assignment.rb', line 488

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_enum_value("addToCalendarAction", @add_to_calendar_action)
    writer.write_enum_value("addedStudentAction", @added_student_action)
    writer.write_boolean_value("allowLateSubmissions", @allow_late_submissions)
    writer.write_boolean_value("allowStudentsToAddResourcesToSubmission", @allow_students_to_add_resources_to_submission)
    writer.write_object_value("assignTo", @assign_to)
    writer.write_collection_of_object_values("categories", @categories)
    writer.write_string_value("classId", @class_id)
    writer.write_date_time_value("closeDateTime", @close_date_time)
    writer.write_string_value("displayName", @display_name)
    writer.write_date_time_value("dueDateTime", @due_date_time)
    writer.write_object_value("grading", @grading)
    writer.write_object_value("instructions", @instructions)
    writer.write_string_value("notificationChannelUrl", @notification_channel_url)
    writer.write_collection_of_object_values("resources", @resources)
    writer.write_object_value("rubric", @rubric)
    writer.write_collection_of_object_values("submissions", @submissions)
end

#status ⇒ Object

Gets the status property value. Status of the Assignment. You can’t PATCH this value. Possible values are: draft, scheduled, published, assigned.



512
513
514
 
# File 'lib/models/education_assignment.rb', line 512

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. Status of the Assignment. You can’t PATCH this value. Possible values are: draft, scheduled, published, assigned.



520
521
522
 
# File 'lib/models/education_assignment.rb', line 520

def status=(value)
    @status = value
end

#submissions ⇒ Object

Gets the submissions property value. Once published, there is a submission object for each student representing their work and grade. Read-only. Nullable.



527
528
529
 
# File 'lib/models/education_assignment.rb', line 527

def submissions
    return @submissions
end

#submissions=(value) ⇒ Object

Sets the submissions property value. Once published, there is a submission object for each student representing their work and grade. Read-only. Nullable.



535
536
537
 
# File 'lib/models/education_assignment.rb', line 535

def submissions=(value)
    @submissions = value
end

#web_url ⇒ Object

Gets the webUrl property value. The deep link URL for the given assignment.



542
543
544
 
# File 'lib/models/education_assignment.rb', line 542

def web_url
    return @web_url
end

#web_url=(value) ⇒ Object

Sets the webUrl property value. The deep link URL for the given assignment.



550
551
552
 
# File 'lib/models/education_assignment.rb', line 550

def web_url=(value)
    @web_url = value
end