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



207
208
209
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 207

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) 


140
141
142
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 140

def alternate_link
  @alternate_link
end

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

Additional details for assignments. Corresponds to the JSON property assignment

Returns:



198
199
200
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 198

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) 


119
120
121
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 119

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) 


186
187
188
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 186

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) 


180
181
182
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 180

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


104
105
106
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 104

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:



169
170
171
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 169

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:



205
206
207
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 205

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) 


97
98
99
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 97

def id
  @id
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:



152
153
154
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 152

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) 


193
194
195
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 193

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:



174
175
176
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 174

def multiple_choice_question
  @multiple_choice_question
end

#state ⇒ String

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

Returns:

  • (String) 


158
159
160
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 158

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) 


110
111
112
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 110

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) 


133
134
135
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 133

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) 


126
127
128
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 126

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) 


146
147
148
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 146

def work_type
  @work_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 212

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