class Google::Apis::ClassroomV1::Course
A Course
in Classroom.
Attributes
Absolute link to this course in the Classroom web UI. Read-only. Corresponds to the JSON property `alternateLink` @return [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` @return [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` @return [String]
Sets of materials that appear on the “about” page of this course. Read-only. Corresponds to the JSON property `courseMaterialSets` @return [Array<Google::Apis::ClassroomV1::CourseMaterialSet>]
State of the course. If unspecified, the default state is `PROVISIONED`. Corresponds to the JSON property `courseState` @return [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` @return [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` @return [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` @return [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` @return [String]
Whether or not guardian notifications are enabled for this course. Read-only. Corresponds to the JSON property `guardiansEnabled` @return [Boolean]
Whether or not guardian notifications are enabled for this course. Read-only. Corresponds to the JSON property `guardiansEnabled` @return [Boolean]
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` @return [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` @return [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` @return [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` @return [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` @return [String]
Representation
of a Google
Drive folder. Corresponds to the JSON property `teacherFolder` @return [Google::Apis::ClassroomV1::DriveFolder]
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` @return [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` @return [String]
Public Class Methods
# File lib/google/apis/classroom_v1/classes.rb, line 338 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/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