Class: Google::Apis::ClassroomV1::Course

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

A Course in Classroom.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Course

Returns a new instance of Course.



338
339
340
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 338

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

Instance Attribute Details

Absolute link to this course in the Classroom web UI. Read-only. Corresponds to the JSON property alternateLink

Returns:

  • (String) 


225
226
227
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 225

def alternate_link
  @alternate_link
end

#calendar_id ⇒ String

The Calendar ID for a calendar that all course members can see, to which Classroom adds events for course work and announcements in the course. Read- only. Corresponds to the JSON property calendarId

Returns:

  • (String) 


232
233
234
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 232

def calendar_id
  @calendar_id
end

#course_group_email ⇒ String

The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only. Corresponds to the JSON property courseGroupEmail

Returns:

  • (String) 


238
239
240
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 238

def course_group_email
  @course_group_email
end

#course_material_sets ⇒ Array<Google::Apis::ClassroomV1::CourseMaterialSet>

Sets of materials that appear on the "about" page of this course. Read-only. Corresponds to the JSON property courseMaterialSets

Returns:



243
244
245
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 243

def course_material_sets
  @course_material_sets
end

#course_state ⇒ String

State of the course. If unspecified, the default state is PROVISIONED. Corresponds to the JSON property courseState

Returns:

  • (String) 


248
249
250
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 248

def course_state
  @course_state
end

#creation_time ⇒ String

Creation time of the course. Specifying this field in a course update mask results in an error. Read-only. Corresponds to the JSON property creationTime

Returns:

  • (String) 


254
255
256
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 254

def creation_time
  @creation_time
end

#description ⇒ String

Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. Corresponds to the JSON property description

Returns:

  • (String) 


262
263
264
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 262

def description
  @description
end

#description_heading ⇒ String

Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. Corresponds to the JSON property descriptionHeading

Returns:

  • (String) 


269
270
271
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 269

def description_heading
  @description_heading
end

#enrollment_code ⇒ String

Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only. Corresponds to the JSON property enrollmentCode

Returns:

  • (String) 


275
276
277
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 275

def enrollment_code
  @enrollment_code
end

#guardians_enabled ⇒ Boolean Also known as: guardians_enabled?

Whether or not guardian notifications are enabled for this course. Read-only. Corresponds to the JSON property guardiansEnabled

Returns:

  • (Boolean) 


280
281
282
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 280

def guardians_enabled
  @guardians_enabled
end

#id ⇒ String

Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The id is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error. Corresponds to the JSON property id

Returns:

  • (String) 


290
291
292
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 290

def id
  @id
end

#name ⇒ String

Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. Corresponds to the JSON property name

Returns:

  • (String) 


296
297
298
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 296

def name
  @name
end

#owner_id ⇒ String

The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user This must be set in a create request. Admins can also specify this field in a patch course request to transfer ownership. In other contexts, it is read-only. Corresponds to the JSON property ownerId

Returns:

  • (String) 


306
307
308
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 306

def owner_id
  @owner_id
end

#room ⇒ String

Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. Corresponds to the JSON property room

Returns:

  • (String) 


312
313
314
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 312

def room
  @room
end

#section ⇒ String

Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. Corresponds to the JSON property section

Returns:

  • (String) 


318
319
320
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 318

def section
  @section
end

#teacher_folder ⇒ Google::Apis::ClassroomV1::DriveFolder

Representation of a Google Drive folder. Corresponds to the JSON property teacherFolder

Returns:



323
324
325
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 323

def teacher_folder
  @teacher_folder
end

#teacher_group_email ⇒ String

The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read- only. Corresponds to the JSON property teacherGroupEmail

Returns:

  • (String) 


330
331
332
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 330

def teacher_group_email
  @teacher_group_email
end

#update_time ⇒ String

Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only. Corresponds to the JSON property updateTime

Returns:

  • (String) 


336
337
338
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 336

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 343

def update!(**args)
  @alternate_link = args[:alternate_link] if args.key?(:alternate_link)
  @calendar_id = args[:calendar_id] if args.key?(:calendar_id)
  @course_group_email = args[:course_group_email] if args.key?(:course_group_email)
  @course_material_sets = args[:course_material_sets] if args.key?(:course_material_sets)
  @course_state = args[:course_state] if args.key?(:course_state)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @description = args[:description] if args.key?(:description)
  @description_heading = args[:description_heading] if args.key?(:description_heading)
  @enrollment_code = args[:enrollment_code] if args.key?(:enrollment_code)
  @guardians_enabled = args[:guardians_enabled] if args.key?(:guardians_enabled)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
  @owner_id = args[:owner_id] if args.key?(:owner_id)
  @room = args[:room] if args.key?(:room)
  @section = args[:section] if args.key?(:section)
  @teacher_folder = args[:teacher_folder] if args.key?(:teacher_folder)
  @teacher_group_email = args[:teacher_group_email] if args.key?(:teacher_group_email)
  @update_time = args[:update_time] if args.key?(:update_time)
end