Class: Google::Apis::ClassroomV1::Course
- Inherits:
-
Object
- Object
- Google::Apis::ClassroomV1::Course
- 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
-
#alternate_link ⇒ String
Absolute link to this course in the Classroom web UI.
-
#course_group_email ⇒ String
The email address of a Google group containing all members of the course.
-
#course_material_sets ⇒ Array<Google::Apis::ClassroomV1::CourseMaterialSet>
Sets of materials that appear on the "about" page of this course.
-
#course_state ⇒ String
State of the course.
-
#creation_time ⇒ String
Creation time of the course.
-
#description ⇒ String
Optional description.
-
#description_heading ⇒ String
Optional heading for the description.
-
#enrollment_code ⇒ String
Enrollment code to use when joining this course.
-
#guardians_enabled ⇒ Boolean
(also: #guardians_enabled?)
Whether or not guardian notifications are enabled for this course.
-
#id ⇒ String
Identifier for this course assigned by Classroom.
-
#name ⇒ String
Name of the course.
-
#owner_id ⇒ String
The identifier of the owner of a course.
-
#room ⇒ String
Optional room location.
-
#section ⇒ String
Section of the course.
-
#teacher_folder ⇒ Google::Apis::ClassroomV1::DriveFolder
Representation of a Google Drive folder.
-
#teacher_group_email ⇒ String
The email address of a Google group containing all teachers of the course.
-
#update_time ⇒ String
Time of the most recent update to this course.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Course
constructor
A new instance of Course.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Course
Returns a new instance of Course.
138 139 140 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 138 def initialize(**args) update!(**args) end |
Instance Attribute Details
#alternate_link ⇒ String
Absolute link to this course in the Classroom web UI. Read-only.
Corresponds to the JSON property alternateLink
107 108 109 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 107 def alternate_link @alternate_link 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
120 121 122 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 120 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
130 131 132 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 130 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
102 103 104 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 102 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
85 86 87 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 85 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
63 64 65 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 63 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
55 56 57 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 55 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
97 98 99 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 97 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
135 136 137 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 135 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
36 37 38 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 36 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
42 43 44 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 42 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. Specifying this field in a course update mask
results in an INVALID_ARGUMENT
error.
Corresponds to the JSON property ownerId
79 80 81 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 79 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
69 70 71 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 69 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
48 49 50 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 48 def section @section end |
#teacher_folder ⇒ Google::Apis::ClassroomV1::DriveFolder
Representation of a Google Drive folder.
Corresponds to the JSON property teacherFolder
125 126 127 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 125 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
114 115 116 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 114 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
91 92 93 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 91 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 143 def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @section = args[:section] if args.key?(:section) @description_heading = args[:description_heading] if args.key?(:description_heading) @description = args[:description] if args.key?(:description) @room = args[:room] if args.key?(:room) @owner_id = args[:owner_id] if args.key?(:owner_id) @creation_time = args[:creation_time] if args.key?(:creation_time) @update_time = args[:update_time] if args.key?(:update_time) @enrollment_code = args[:enrollment_code] if args.key?(:enrollment_code) @course_state = args[:course_state] if args.key?(:course_state) @alternate_link = args[:alternate_link] if args.key?(:alternate_link) @teacher_group_email = args[:teacher_group_email] if args.key?(:teacher_group_email) @course_group_email = args[:course_group_email] if args.key?(:course_group_email) @teacher_folder = args[:teacher_folder] if args.key?(:teacher_folder) @course_material_sets = args[:course_material_sets] if args.key?(:course_material_sets) @guardians_enabled = args[:guardians_enabled] if args.key?(:guardians_enabled) end |