Class: Google::Apis::ClassroomV1::CourseWork

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/classroom_v1/classes.rb,
generated/google/apis/classroom_v1/representations.rb,
generated/google/apis/classroom_v1/representations.rb

Overview

Course work created by a teacher for students of the course.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CourseWork

Returns a new instance of CourseWork



501
502
503
# File 'generated/google/apis/classroom_v1/classes.rb', line 501

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

Absolute link to this course work in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only. Corresponds to the JSON property alternateLink

Returns:

  • (String)


387
388
389
# File 'generated/google/apis/classroom_v1/classes.rb', line 387

def alternate_link
  @alternate_link
end

#assignmentGoogle::Apis::ClassroomV1::Assignment

Additional details for assignments. Corresponds to the JSON property assignment



392
393
394
# File 'generated/google/apis/classroom_v1/classes.rb', line 392

def assignment
  @assignment
end

#associated_with_developerBoolean Also known as: associated_with_developer?

Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only. Corresponds to the JSON property associatedWithDeveloper

Returns:

  • (Boolean)


401
402
403
# File 'generated/google/apis/classroom_v1/classes.rb', line 401

def associated_with_developer
  @associated_with_developer
end

#course_idString

Identifier of the course. Read-only. Corresponds to the JSON property courseId

Returns:

  • (String)


408
409
410
# File 'generated/google/apis/classroom_v1/classes.rb', line 408

def course_id
  @course_id
end

#creation_timeString

Timestamp when this course work was created. Read-only. Corresponds to the JSON property creationTime

Returns:

  • (String)


414
415
416
# File 'generated/google/apis/classroom_v1/classes.rb', line 414

def creation_time
  @creation_time
end

#descriptionString

Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. Corresponds to the JSON property description

Returns:

  • (String)


421
422
423
# File 'generated/google/apis/classroom_v1/classes.rb', line 421

def description
  @description
end

#due_dateGoogle::Apis::ClassroomV1::Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property dueDate



432
433
434
# File 'generated/google/apis/classroom_v1/classes.rb', line 432

def due_date
  @due_date
end

#due_timeGoogle::Apis::ClassroomV1::TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp. Corresponds to the JSON property dueTime



439
440
441
# File 'generated/google/apis/classroom_v1/classes.rb', line 439

def due_time
  @due_time
end

#idString

Classroom-assigned identifier of this course work, unique per course. Read-only. Corresponds to the JSON property id

Returns:

  • (String)


445
446
447
# File 'generated/google/apis/classroom_v1/classes.rb', line 445

def id
  @id
end

#materialsArray<Google::Apis::ClassroomV1::Material>

Additional materials. CourseWork must have no more than 20 material items. Corresponds to the JSON property materials



451
452
453
# File 'generated/google/apis/classroom_v1/classes.rb', line 451

def materials
  @materials
end

#max_pointsFloat

Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. Corresponds to the JSON property maxPoints

Returns:

  • (Float)


458
459
460
# File 'generated/google/apis/classroom_v1/classes.rb', line 458

def max_points
  @max_points
end

#multiple_choice_questionGoogle::Apis::ClassroomV1::MultipleChoiceQuestion

Additional details for multiple-choice questions. Corresponds to the JSON property multipleChoiceQuestion



463
464
465
# File 'generated/google/apis/classroom_v1/classes.rb', line 463

def multiple_choice_question
  @multiple_choice_question
end

#scheduled_timeString

Optional timestamp when this course work is scheduled to be published. Corresponds to the JSON property scheduledTime

Returns:

  • (String)


468
469
470
# File 'generated/google/apis/classroom_v1/classes.rb', line 468

def scheduled_time
  @scheduled_time
end

#stateString

Status of this course work. If unspecified, the default state is DRAFT. Corresponds to the JSON property state

Returns:

  • (String)


474
475
476
# File 'generated/google/apis/classroom_v1/classes.rb', line 474

def state
  @state
end

#submission_modification_modeString

Setting to determine when students are allowed to modify submissions. If unspecified, the default value is MODIFIABLE_UNTIL_TURNED_IN. Corresponds to the JSON property submissionModificationMode

Returns:

  • (String)


480
481
482
# File 'generated/google/apis/classroom_v1/classes.rb', line 480

def submission_modification_mode
  @submission_modification_mode
end

#titleString

Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. Corresponds to the JSON property title

Returns:

  • (String)


487
488
489
# File 'generated/google/apis/classroom_v1/classes.rb', line 487

def title
  @title
end

#update_timeString

Timestamp of the most recent change to this course work. Read-only. Corresponds to the JSON property updateTime

Returns:

  • (String)


493
494
495
# File 'generated/google/apis/classroom_v1/classes.rb', line 493

def update_time
  @update_time
end

#work_typeString

Type of this course work. The type is set when the course work is created and cannot be changed. Corresponds to the JSON property workType

Returns:

  • (String)


499
500
501
# File 'generated/google/apis/classroom_v1/classes.rb', line 499

def work_type
  @work_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
# File 'generated/google/apis/classroom_v1/classes.rb', line 506

def update!(**args)
  @alternate_link = args[:alternate_link] if args.key?(:alternate_link)
  @assignment = args[:assignment] if args.key?(:assignment)
  @associated_with_developer = args[:associated_with_developer] if args.key?(:associated_with_developer)
  @course_id = args[:course_id] if args.key?(:course_id)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @description = args[:description] if args.key?(:description)
  @due_date = args[:due_date] if args.key?(:due_date)
  @due_time = args[:due_time] if args.key?(:due_time)
  @id = args[:id] if args.key?(:id)
  @materials = args[:materials] if args.key?(:materials)
  @max_points = args[:max_points] if args.key?(:max_points)
  @multiple_choice_question = args[:multiple_choice_question] if args.key?(:multiple_choice_question)
  @scheduled_time = args[:scheduled_time] if args.key?(:scheduled_time)
  @state = args[:state] if args.key?(:state)
  @submission_modification_mode = args[:submission_modification_mode] if args.key?(:submission_modification_mode)
  @title = args[:title] if args.key?(:title)
  @update_time = args[:update_time] if args.key?(:update_time)
  @work_type = args[:work_type] if args.key?(:work_type)
end