classroom  v1
Properties | List of all members
Google.Apis.Classroom.v1.Data.Course Class Reference

A Course in Classroom. More...

Inheritance diagram for Google.Apis.Classroom.v1.Data.Course:
Google::Apis::Requests::IDirectResponseSchema

Properties

virtual string AlternateLink [get, set]
 Absolute link to this course in the Classroom web UI. More...
 
virtual string CalendarId [get, set]
 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. More...
 
virtual string CourseGroupEmail [get, set]
 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. More...
 
virtual System.Collections.Generic.IList< CourseMaterialSetCourseMaterialSets [get, set]
 Sets of materials that appear on the "about" page of this course. More...
 
virtual string CourseState [get, set]
 State of the course. If unspecified, the default state is PROVISIONED. More...
 
virtual object CreationTime [get, set]
 Creation time of the course. Specifying this field in a course update mask results in an error. More...
 
virtual string Description [get, set]
 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. More...
 
virtual string DescriptionHeading [get, set]
 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. More...
 
virtual string EnrollmentCode [get, set]
 Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. More...
 
virtual System.Nullable< bool > GuardiansEnabled [get, set]
 Whether or not guardian notifications are enabled for this course. More...
 
virtual string Id [get, set]
 Identifier for this course assigned by Classroom. More...
 
virtual string Name [get, set]
 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. More...
 
virtual string OwnerId [get, set]
 The identifier of the owner of a course. More...
 
virtual string Room [get, set]
 Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. More...
 
virtual string Section [get, set]
 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. More...
 
virtual DriveFolder TeacherFolder [get, set]
 Information about a Drive Folder that is shared with all teachers of the course. More...
 
virtual string TeacherGroupEmail [get, set]
 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. More...
 
virtual object UpdateTime [get, set]
 Time of the most recent update to this course. Specifying this field in a course update mask results in an error. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

A Course in Classroom.

Property Documentation

◆ AlternateLink

virtual string Google.Apis.Classroom.v1.Data.Course.AlternateLink
getset

Absolute link to this course in the Classroom web UI.

Read-only.

◆ CalendarId

virtual string Google.Apis.Classroom.v1.Data.Course.CalendarId
getset

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.

◆ CourseGroupEmail

virtual string Google.Apis.Classroom.v1.Data.Course.CourseGroupEmail
getset

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.

◆ CourseMaterialSets

virtual System.Collections.Generic.IList<CourseMaterialSet> Google.Apis.Classroom.v1.Data.Course.CourseMaterialSets
getset

Sets of materials that appear on the "about" page of this course.

Read-only.

◆ CourseState

virtual string Google.Apis.Classroom.v1.Data.Course.CourseState
getset

State of the course. If unspecified, the default state is PROVISIONED.

◆ CreationTime

virtual object Google.Apis.Classroom.v1.Data.Course.CreationTime
getset

Creation time of the course. Specifying this field in a course update mask results in an error.

Read-only.

◆ Description

virtual string Google.Apis.Classroom.v1.Data.Course.Description
getset

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.

◆ DescriptionHeading

virtual string Google.Apis.Classroom.v1.Data.Course.DescriptionHeading
getset

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.

◆ EnrollmentCode

virtual string Google.Apis.Classroom.v1.Data.Course.EnrollmentCode
getset

Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error.

Read-only.

◆ ETag

virtual string Google.Apis.Classroom.v1.Data.Course.ETag
getset

The ETag of the item.

◆ GuardiansEnabled

virtual System.Nullable<bool> Google.Apis.Classroom.v1.Data.Course.GuardiansEnabled
getset

Whether or not guardian notifications are enabled for this course.

Read-only.

◆ Id

virtual string Google.Apis.Classroom.v1.Data.Course.Id
getset

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.

◆ Name

virtual string Google.Apis.Classroom.v1.Data.Course.Name
getset

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.

◆ OwnerId

virtual string Google.Apis.Classroom.v1.Data.Course.OwnerId
getset

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.

◆ Room

virtual string Google.Apis.Classroom.v1.Data.Course.Room
getset

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

◆ Section

virtual string Google.Apis.Classroom.v1.Data.Course.Section
getset

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.

◆ TeacherFolder

virtual DriveFolder Google.Apis.Classroom.v1.Data.Course.TeacherFolder
getset

Information about a Drive Folder that is shared with all teachers of the course.

This field will only be set for teachers of the course and domain administrators.

Read-only.

◆ TeacherGroupEmail

virtual string Google.Apis.Classroom.v1.Data.Course.TeacherGroupEmail
getset

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.

◆ UpdateTime

virtual object Google.Apis.Classroom.v1.Data.Course.UpdateTime
getset

Time of the most recent update to this course. Specifying this field in a course update mask results in an error.

Read-only.


The documentation for this class was generated from the following file: