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



660
661
662
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 660

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) 


528
529
530
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 528

def alternate_link
  @alternate_link
end

#assignee_mode ⇒ String

Assignee mode of the coursework. If unspecified, the default value is ALL_STUDENTS. Corresponds to the JSON property assigneeMode

Returns:

  • (String) 


534
535
536
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 534

def assignee_mode
  @assignee_mode
end

#assignment ⇒ Google::Apis::ClassroomV1::Assignment

Additional details for assignments. Corresponds to the JSON property assignment

Returns:



539
540
541
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 539

def assignment
  @assignment
end

#associated_with_developer ⇒ Boolean 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) 


548
549
550
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 548

def associated_with_developer
  @associated_with_developer
end

#course_id ⇒ String

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

Returns:

  • (String) 


555
556
557
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 555

def course_id
  @course_id
end

#creation_time ⇒ String

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

Returns:

  • (String) 


561
562
563
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 561

def creation_time
  @creation_time
end

#creator_user_id ⇒ String

Identifier for the user that created the coursework. Read-only. Corresponds to the JSON property creatorUserId

Returns:

  • (String) 


567
568
569
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 567

def creator_user_id
  @creator_user_id
end

#description ⇒ String

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) 


574
575
576
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 574

def description
  @description
end

#due_date ⇒ Google::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

Returns:



585
586
587
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 585

def due_date
  @due_date
end

#due_time ⇒ Google::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

Returns:



592
593
594
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 592

def due_time
  @due_time
end

#id ⇒ String

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

Returns:

  • (String) 


598
599
600
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 598

def id
  @id
end

#individual_students_options ⇒ Google::Apis::ClassroomV1::IndividualStudentsOptions

Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS. Corresponds to the JSON property individualStudentsOptions

Returns:



604
605
606
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 604

def individual_students_options
  @individual_students_options
end

#materials ⇒ Array<Google::Apis::ClassroomV1::Material>

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

Returns:



610
611
612
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 610

def materials
  @materials
end

#max_points ⇒ Float

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) 


617
618
619
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 617

def max_points
  @max_points
end

#multiple_choice_question ⇒ Google::Apis::ClassroomV1::MultipleChoiceQuestion

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

Returns:



622
623
624
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 622

def multiple_choice_question
  @multiple_choice_question
end

#scheduled_time ⇒ String

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

Returns:

  • (String) 


627
628
629
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 627

def scheduled_time
  @scheduled_time
end

#state ⇒ String

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

Returns:

  • (String) 


633
634
635
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 633

def state
  @state
end

#submission_modification_mode ⇒ String

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) 


639
640
641
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 639

def submission_modification_mode
  @submission_modification_mode
end

#title ⇒ String

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) 


646
647
648
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 646

def title
  @title
end

#update_time ⇒ String

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

Returns:

  • (String) 


652
653
654
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 652

def update_time
  @update_time
end

#work_type ⇒ String

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) 


658
659
660
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 658

def work_type
  @work_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 665

def update!(**args)
  @alternate_link = args[:alternate_link] if args.key?(:alternate_link)
  @assignee_mode = args[:assignee_mode] if args.key?(:assignee_mode)
  @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)
  @creator_user_id = args[:creator_user_id] if args.key?(:creator_user_id)
  @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)
  @individual_students_options = args[:individual_students_options] if args.key?(:individual_students_options)
  @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