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.


615
616
617
# File 'generated/google/apis/classroom_v1/classes.rb', line 615

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)

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

def alternate_link
  @alternate_link
end

#assignee_modeString

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

Returns:

  • (String)

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

def assignee_mode
  @assignee_mode
end

#assignmentGoogle::Apis::ClassroomV1::Assignment

Additional details for assignments. Corresponds to the JSON property assignment


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

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 CreateCourseWork for more details. Read-only. Corresponds to the JSON property associatedWithDeveloper

Returns:

  • (Boolean)

505
506
507
# File 'generated/google/apis/classroom_v1/classes.rb', line 505

def associated_with_developer
  @associated_with_developer
end

#course_idString

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

Returns:

  • (String)

511
512
513
# File 'generated/google/apis/classroom_v1/classes.rb', line 511

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)

516
517
518
# File 'generated/google/apis/classroom_v1/classes.rb', line 516

def creation_time
  @creation_time
end

#creator_user_idString

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

Returns:

  • (String)

521
522
523
# File 'generated/google/apis/classroom_v1/classes.rb', line 521

def creator_user_id
  @creator_user_id
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)

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

def description
  @description
end

#due_dateGoogle::Apis::ClassroomV1::Date

Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf. Timestamp. Corresponds to the JSON property dueDate


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

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


546
547
548
# File 'generated/google/apis/classroom_v1/classes.rb', line 546

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)

552
553
554
# File 'generated/google/apis/classroom_v1/classes.rb', line 552

def id
  @id
end

#individual_students_optionsGoogle::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


558
559
560
# File 'generated/google/apis/classroom_v1/classes.rb', line 558

def individual_students_options
  @individual_students_options
end

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

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


563
564
565
# File 'generated/google/apis/classroom_v1/classes.rb', line 563

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)

569
570
571
# File 'generated/google/apis/classroom_v1/classes.rb', line 569

def max_points
  @max_points
end

#multiple_choice_questionGoogle::Apis::ClassroomV1::MultipleChoiceQuestion

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


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

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)

579
580
581
# File 'generated/google/apis/classroom_v1/classes.rb', line 579

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)

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

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)

590
591
592
# File 'generated/google/apis/classroom_v1/classes.rb', line 590

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)

596
597
598
# File 'generated/google/apis/classroom_v1/classes.rb', line 596

def title
  @title
end

#topic_idString

Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. Corresponds to the JSON property topicId

Returns:

  • (String)

602
603
604
# File 'generated/google/apis/classroom_v1/classes.rb', line 602

def topic_id
  @topic_id
end

#update_timeString

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

Returns:

  • (String)

607
608
609
# File 'generated/google/apis/classroom_v1/classes.rb', line 607

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)

613
614
615
# File 'generated/google/apis/classroom_v1/classes.rb', line 613

def work_type
  @work_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
# File 'generated/google/apis/classroom_v1/classes.rb', line 620

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)
  @topic_id = args[:topic_id] if args.key?(:topic_id)
  @update_time = args[:update_time] if args.key?(:update_time)
  @work_type = args[:work_type] if args.key?(:work_type)
end